v1

latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.8 MB

Subscriptions API

Create subscription

With subscriptions, you can schedule recurring payments to take place at regular intervals.

For example, by simply specifying an amount and an interval, you can create an endless subscription to charge a monthly fee, until you cancel the subscription.

Or, you could use the times parameter to only charge a limited number of times, for example to split a big transaction in multiple parts.

A few example usages:

amount[currency]="EUR" amount[value]="5.00" interval="2 weeks" Your customer will be charged €5 once every two weeks.

amount[currency]="EUR" amount[value]="20.00" interval="1 day" times=5 Your customer will be charged €20 every day, for five consecutive days.

amount[currency]="EUR" amount[value]="10.00" interval="1 month" startDate="2018-04-30" Your customer will be charged €10 on the last day of each month, starting in April 2018.

🔑 Access with

API key

Advanced access token with subscriptions.write

OAuth access with subscriptions.write

post/customers/{customerId}/subscriptions

Request body

resourcestring

Indicates the response contains a subscription object. Will always contain the string subscription for this endpoint.

idstring

The identifier uniquely referring to this subscription. Example: sub_rVKGtNd6s3.

modestring

Whether this entity was created in live mode or in test mode.

Possible values: live test

statusstring

The subscription's current status is directly related to the status of the underlying customer or mandate that is enabling the subscription.

Possible values: pending active canceled suspended completed

timesinteger nullable

Total number of payments for the subscription. Once this number of payments is reached, the subscription is considered completed.

Test mode subscriptions will get canceled automatically after 10 payments.

timesRemaininginteger nullable

Number of payments left for the subscription.

intervalstring required

Interval to wait between payments, for example 1 month or 14 days.

The maximum interval is one year (12 months, 52 weeks, or 365 days).

Possible values: ... days, ... weeks, ... months.

startDatestring

The start date of the subscription in YYYY-MM-DD format.

nextPaymentDatestring nullable

The date of the next scheduled payment in YYYY-MM-DD format. If the subscription has been completed or canceled, this parameter will not be returned.

descriptionstring required

The subscription's description will be used as the description of the resulting individual payments and so showing up on the bank statement of the consumer.

Please note: the description needs to be unique for the Customer in case it has multiple active subscriptions.

methodstring nullable

The payment method used for this subscription. If omitted, any of the customer's valid mandates may be used.

Possible values: creditcard directdebit paypal

webhookUrlstring nullable

We will call this URL for any payment status changes of payments resulting from this subscription.

This webhook will receive all events for the subscription's payments. This may include payment failures as well. Be sure to verify the payment's subscription ID and its status.

customerIdstring

The customer this subscription belongs to.

mandateIdstring nullable

The mandate used for this subscription, if any.

createdAtstring

The entity's date and time of creation, in ISO 8601 format.

canceledAtstring nullable

The subscription's date and time of cancellation, in ISO 8601 format. This parameter is omitted if the subscription is not canceled (yet).

profileIdstring

The identifier referring to the profile this entity belongs to.

When using an API Key, the profileId must not be sent since it is linked to the key. However, for OAuth and Organization tokens, the profileId is required.

For more information, see Authentication.

testmodeboolean nullable

Whether to create the entity in test mode or live mode.

Most API credentials are specifically created for either live mode or test mode, in which case this parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting testmode to true.

Example request

{
  "id": "sub_5B8cwPMGnU",
  "mode": "live",
  "status": "active",
  "amount": {
    "currency": "EUR",
    "value": "10.00"
  },
  "times": 6,
  "timesRemaining": 5,
  "interval": "2 days",
  "startDate": "2025-01-01",
  "nextPaymentDate": "2025-01-01",
  "description": "Subscription of streaming channel",
  "method": "paypal",
  "applicationFee": {
    "amount": {
      "currency": "EUR",
      "value": "10.00"
    },
    "description": "Platform fee"
  },
  "webhookUrl": "https://example.com/webhook",
  "customerId": "cst_5B8cwPMGnU",
  "mandateId": "mdt_5B8cwPMGnU",
  "createdAt": "2024-03-20T09:13:37+00:00",
  "canceledAt": "2025-01-01T13:10:19+00:00",
  "profileId": "pfl_5B8cwPMGnU",
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "customer": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "mandate": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "profile": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "payments": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Response

The newly created subscription object.