tap-stripe

This is a Singer tap that produces JSON-formatted data following the Singer spec.

Installation

See the getting-started guide:

https://github.com/singer-io/getting-started

Usage

This section dives into basic usage of tap-stripe by walking through extracting data from the api.

Create the configuration file

Create a config file containing the stripe credentials, e.g.:

{
  "client_secret": "sk_live_xxxxxxxxxxxxxxxxxxxxxxxx",
  "account_id": "acct_xxxxxxxxxxxxxxxx",
  "start_date": "2017-01-01T00:00:00Z",
  "request_timeout": 300,
  "lookback_window": 600,
  "event_date_window_size": 7,
  "date_window_size": 30,
  "sigma_queries": ["Subscription Events Item Changes"] # optional
}

Syncing Scheduled Sigma Queries

If you have scheduled Sigma queries that you would like to sync you can pass the names of those scheduled queries into the sigma_queries parameter config (array of names).

• The tap will pick the most recent scheduled query run results for each query name to sync.
• If no matching query names are found, the tap will skip that entry and continue.
• Schemas for Sigma queries are generated automatically each time the sync is ran, no need to specify the schemas manually.
• Primary keys are not defined for Sigma queries. Your loader should handle this. Typically this involves a full-append to the target table or you can do a full drop and replace.
• Only full-table replication is possible for Sigma queries at this time. If you want incremental query results, you might be able to set that up in Stripe.

More docs on scheduled Stripe Sigma queries and file retrieval:

• https://docs.stripe.com/stripe-data/schedule-queries#schedule
• https://docs.stripe.com/api/sigma/scheduled_queries
• https://docs.stripe.com/api/files/retrieve

Discovery mode

The tap can be invoked in discovery mode to find the available stripe entities.

$ tap-stripe --config config.json --discover

A discovered catalog is output, with a JSON-schema description of each table. A source table directly corresponds to a Singer stream.

Field selection

In sync mode, tap-stripe consumes the catalog and looks for streams that have been marked as selected in their associated metadata entries.

Redirect output from the tap's discovery mode to a file so that it can be modified:

$ tap-stripe --config config.json --discover > catalog.json

Then edit catalog.json to make selections. The stream's metadata entry (associated with "breadcrumb": []) gets a top-level selected flag, as does its columns' metadata entries.

[
  {
    "breadcrumb": [],
    "metadata": {
      "valid-replication-keys": [
        "created"
      ],
      "table-key-properties": [
        "id"
      ],
      "forced-replication-method": "INCREMENTAL",
+      "selected": "true"
    }
  },
]

Sync mode

With a catalog.json that describes field and table selections, the tap can be invoked in sync mode:

$ tap-stripe --config config.json --catalog catalog.json

Messages are written to standard output following the Singer specification. The resultant stream of JSON data can be consumed by a Singer target.

---

Copyright © 2018 Stitch