Substy Developers
Scripts

List creator subscriptions

List a creator's Substy subscriptions, optionally filtering active, overdue or canceled states and recent cancellations. These are agency plan subscriptions, not fan subscriptions.

GET/v1/agencies/{agencyId}/creators/{creatorId}/subscriptions

List a creator's Substy subscriptions, optionally filtering active, overdue or canceled states and recent cancellations. These are agency plan subscriptions, not fan subscriptions.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length
creatorId*string

Query Parameters

status?array<>
canceledSinceDays?number
limit?number
Range1 <= value <= 100
Default20

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/agencies/string/creators/string/subscriptions" \  -H "Authorization: Bearer YOUR_API_KEY"
{  "data": [    {      "creatorId": "string",      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "status": "ACTIVE",      "updatedAt": "2019-08-24T14:15:22Z",      "startDate": "2019-08-24T14:15:22Z",      "endDate": null,      "rate": null,      "planId": "string",      "billingCycle": "DAILY",      "walletId": null,      "subscriptionPrice": "string",      "nextBillingDate": null,      "lastBillingDate": null,      "consecutiveFailures": 0,      "maxAllowedFailures": 0,      "suspendedAt": null,      "isTrial": true    }  ],  "meta": {    "requestId": "string"  }}

Get fan script availability GET

Check script availability for up to 100 specified fans of one creator. Split larger fan sets into separate requests.

Cancel creator subscription POST

Cancel the creator's Substy subscription according to the subscription's current billing and cancellation rules.