Create subscription

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "handle": "<string>",
  "currency": "USD",
  "term": {
    "start": "2023-12-25",
    "end": "2023-12-25"
  },
  "autoRenewal": true,
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "billAt": "2023-11-07T05:31:56Z",
      "period": {
        "start": "2023-12-25",
        "end": "2023-12-25"
      },
      "quantity": 123,
      "product": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "price": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z"
}

POST

subscriptions

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "handle": "<string>",
  "currency": "USD",
  "term": {
    "start": "2023-12-25",
    "end": "2023-12-25"
  },
  "autoRenewal": true,
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "billAt": "2023-11-07T05:31:56Z",
      "period": {
        "start": "2023-12-25",
        "end": "2023-12-25"
      },
      "quantity": 123,
      "product": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "price": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z"
}

Headers

x-environment

string<uuid>

required

Configure which environment the request will handle. If the provided credentials do not allow access to this specified environment, a 403 Forbidden response is returned.

Body

application/json

currency

string | null

required

Three-letter ISO currency code, in lowercase. Must be a supported currency (https://go.plude.io/h11101).

customerId

string<uuid>

required

Id of the customer to subscribe.

start

string<date>

required

Start of the current term of the subscription.

description

string | null

A description, meant to be displayable to the customer.

end

string<date> | null

End of the current term of the subscription. If null the subscription is evergreen. At the end of term the subscription will automatically renew if 'autoRenewal' is set to true.

autoRenewal

boolean | null

If true, the subscription will automatically renew at the end of the term. 'End' must be set.

items

object[] | null

A list of up to 20 subscription items, each with an attached price and product.

Show child attributes

items.productId

string<uuid>

required

Id of product to attach to the subscription item.

items.priceId

string<uuid>

required

Id of the price to attach to the subscription item.

items.quantity

number<double>

Quantity of the item to be added to the subscription item. Default 0.

items.billAt

string<date-time> | null

Sets the next billing date of the item. You should optionally set the start date of the billing period.

items.periodFrom

string<date> | null

Sets the start of the item period. If specified, the item period is calculated from this date. Otherwise 'billAt' is used. Item period applies to invoice item upon billing.

items.prorate

object

Show child attributes

items.prorate.strategy

enum<string>

Available options:

no_proration,

remaining_period,

full_period

items.prorate.fromDate

string<date>

The date to prorate from.

metaData

object

Set of key-value pairs that you can freely use to store additional information about your subscription.

Show child attributes

metaData.{key}

string

bookAndSettle

object

Show child attributes

bookAndSettle.book

enum<string>

Available options:

draft,

invoice,

ammendment

Response

string<uuid>

Id of subscription.

handle

string | null

A unique handle of the subscription.

currency

string<currency>

Currency of the subscription.

Example:

"USD"

term

object

Show child attributes

term.start

string<date>

term.end

string<date> | null

autoRenewal

boolean

For termed subscription, auto renewal is optional and will automatically renew the subscription.

items

object[] | null

Items of the subscription.

Show child attributes

items.id

string<uuid>

Id of the subscription item.

items.billAt

string<date-time> | null

Date and time when to bill the subscription item. Items that bill on the same time is grouped on the same invoice.

items.period

object

Show child attributes

items.period.start

string<date>

items.period.end

string<date> | null

items.quantity

number<double>

The quantity or count of units to be billed. Precision to 4.

items.product

object

Show child attributes

items.product.id

string<uuid>

items.product.name

string | null

items.price

object

Show child attributes

items.price.id

string<uuid>

items.price.name

string | null

createdAt

string<date-time>

Cancel subscription Get subscription

⌘I

Welcome

Accounts

Accountsets

Analytics

Authorization

Customers

Discounts

Dunningplans

Environments

Invoices

Paymentproviders

Payments

Prices

Products

Profile

Subscriptions

Templates

Usageevents

Webhooks

Create subscription

Headers

Body

Response