Integrations
Billing & Subscriptions
Payment providers
curl --request POST \
--url https://api.slickerhq.com/ingest/v1/subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subscriptions": [
{
"id": "sub_12345678",
"state": "SUBSCRIPTION_STATE_ACTIVE",
"customerId": "cus_87654321",
"businessEntity": "ACME Inc.",
"planId": "plan_premium_monthly",
"amount": 2000,
"currency": "USD",
"createdAt": "2023-01-01T00:00:00Z",
"updatedAt": "2023-01-05T12:30:00Z",
"activatedAt": "2023-01-01T00:00:00Z",
"expiresAt": "2023-04-01T00:00:00Z",
"billingPeriod": 1,
"billingPeriodUnit": "BILLING_PERIOD_UNIT_MONTH"
},
{
"id": "sub_87654321",
"state": "SUBSCRIPTION_STATE_CANCELED",
"customerId": "cus_12345678",
"businessEntity": "ACME Inc.",
"planId": "plan_basic_annual",
"amount": 10000,
"currency": "USD",
"createdAt": "2022-10-01T00:00:00Z",
"updatedAt": "2023-01-10T09:15:00Z",
"activatedAt": "2022-10-01T00:00:00Z",
"canceledAt": "2023-01-10T09:15:00Z",
"expiresAt": "2023-10-01T00:00:00Z",
"billingPeriod": 1,
"billingPeriodUnit": "BILLING_PERIOD_UNIT_YEAR"
}
]
}
'{
"requestId": "req_2uqkAo1bwllmzrgV2qtGv48DtGI"
}Add subscriptions
Upload one or more subscriptions to be processed by Slicker. Requires authentication with a valid API key passed as a Bearer token. Maximum of 200 subscriptions per request.
curl --request POST \
--url https://api.slickerhq.com/ingest/v1/subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subscriptions": [
{
"id": "sub_12345678",
"state": "SUBSCRIPTION_STATE_ACTIVE",
"customerId": "cus_87654321",
"businessEntity": "ACME Inc.",
"planId": "plan_premium_monthly",
"amount": 2000,
"currency": "USD",
"createdAt": "2023-01-01T00:00:00Z",
"updatedAt": "2023-01-05T12:30:00Z",
"activatedAt": "2023-01-01T00:00:00Z",
"expiresAt": "2023-04-01T00:00:00Z",
"billingPeriod": 1,
"billingPeriodUnit": "BILLING_PERIOD_UNIT_MONTH"
},
{
"id": "sub_87654321",
"state": "SUBSCRIPTION_STATE_CANCELED",
"customerId": "cus_12345678",
"businessEntity": "ACME Inc.",
"planId": "plan_basic_annual",
"amount": 10000,
"currency": "USD",
"createdAt": "2022-10-01T00:00:00Z",
"updatedAt": "2023-01-10T09:15:00Z",
"activatedAt": "2022-10-01T00:00:00Z",
"canceledAt": "2023-01-10T09:15:00Z",
"expiresAt": "2023-10-01T00:00:00Z",
"billingPeriod": 1,
"billingPeriodUnit": "BILLING_PERIOD_UNIT_YEAR"
}
]
}
'{
"requestId": "req_2uqkAo1bwllmzrgV2qtGv48DtGI"
}Authorizations
API key authentication using a Bearer token in the Authorization header.
Example: Authorization: Bearer YOUR_API_KEY
Body
Request to ingest subscription data. Maximum of 200 subscriptions per request.
Show child attributes
Show child attributes
Unique identifier for the subscription
"sub_12345678"
Current state of the subscription
SUBSCRIPTION_STATE_UNSPECIFIED, SUBSCRIPTION_STATE_ACTIVE, SUBSCRIPTION_STATE_CANCELED, SUBSCRIPTION_STATE_EXPIRED, SUBSCRIPTION_STATE_PAUSED, SUBSCRIPTION_STATE_TRIAL "SUBSCRIPTION_STATE_ACTIVE"
Unique identifier for the customer
"cus_87654321"
Business entity associated with this record
"ACME Inc."
Unique identifier for the subscription plan
"plan_premium_monthly"
Monetary amount in smallest unit (e.g., cents)
2000
Three-letter ISO 4217 currency code
"USD"
Timestamp when the subscription was created
"2023-01-01T00:00:00Z"
Timestamp when the subscription was last updated
"2023-01-05T12:30:00Z"
Timestamp when the subscription was activated
"2023-01-01T00:00:00Z"
Timestamp when the subscription was canceled, if applicable
"2023-03-01T00:00:00Z"
Timestamp when the subscription expires, if applicable
"2023-04-01T00:00:00Z"
The billing period length (e.g. 1 for every 1 month/week/year)
1
The unit for the billing period
BILLING_PERIOD_UNIT_UNSPECIFIED, BILLING_PERIOD_UNIT_DAY, BILLING_PERIOD_UNIT_WEEK, BILLING_PERIOD_UNIT_MONTH, BILLING_PERIOD_UNIT_YEAR "BILLING_PERIOD_UNIT_MONTH"
Response
A successful response.
Unique identifier for tracking the request through the system
"req_2uqkAo1bwllmzrgV2qtGv48DtGI"