About the Stripe category

o.plokha · May 8, 2024, 9:03am

Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: Stripe API Reference

Connector package documentation

1. Setting up HTTP Client Stripe

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
Select Stripe HTTP Client as PlatForm and click next step
Fill in the Base URI and API key.
You can optionally enable logging of request to get the log of the authentication.
Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use.

2. Subscribing to Entities from Stripe

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select “Stripe Subscriber” as the subscriber.
Select the entity you want to subscribe to from Stripe.
Add any request parameters needed to subscribe to the entity.
Select the Stripe HTTP Client to use.
You can optionally add a transformer to transform the request parameters into something you will request from Stripe.
You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept

We follow Stripe documentation on building this connector, so you can easily use the connector based on Stripe API Reference.

Entity

The entity you want to subscribe to Stripe. Please refer to the entities from Stripe API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the Stripe API Reference.

Please look at the example below on how to fill path field when we want retrieve a tax code by subscribing “GetTaxIdsId” entity.
Note : We currently use OperationId for the entity, if you need a different label on the entity please call our support

From the end point, we can see that we need to set “id” as parameters. That is why we set the “id” inside the path key in the Request Parameters.

Alumio will then make a request to Stripe with the URL /v1/tax_ids/txcd_99999999

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0

HTTP Client

The HTTP Client configuration you will use to access Stripe.

3. Publishing Entity to Stripe

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select “Stripe Publisher” as the publisher.
Select the Method that you want the publisher to perform with the data.
Select the Stripe entity you want the data to be published to.
You can optionally add any query data to the request on the key query.
You can optionally add any payload data to the request on the key payload.
Select the HTTP Client to use.

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer.

Method

Currently, we support HTTP Post method and HTTP Delete method on submitting data to Stripe.

Entity

We support publishing to most Stripe endpoints.
Please refer to Stripe API Reference page.

For example, we want to delete a customer. Please select “Delete” as the Method and “DeleteCustomersCustomer” as the entity of the publisher.
Note : We currently use OperationId for the entity, if you need a different label on the entity please call our support

From the end point, we can see that we need to set “customer” as parameters. That is why we set the “customer” inside the path key in the data.

Alumio will send an API request to Stripe with URL /v1/customers/cus_Q3svH9nprXKz9u

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0
Payload is the data contained within a request.