Sign in
Subscriptions

Create subscription

Creates a recurring payment subscription. The first order is created immediately; subsequent orders are triggered on the defined schedule.

post/subscriptions

Request body

buyer_idinteger required

Customer ID of the subscriber (buyer).

seller_idinteger

Customer ID of the seller. Required unless auto_settle is true.

namestring required
valuenumber required

Recurring charge amount.

typestring required

Payment method type for the subscription (e.g. CARD).

fee_valuenumber
fee_percentnumber
first_payment_valuenumber

Amount for the first payment if different from value.

timesinteger

Number of billing cycles. Leave null for indefinite.

schedulestring

Cron expression or schedule descriptor (e.g. monthly, weekly).

auto_settleboolean
tagstring
metadataobject
order_metadataobject

Metadata applied to each generated order.

buyer_confirmed_urlstring uri
buyer_denied_urlstring uri
seller_confirmed_urlstring uri
seller_denied_urlstring uri

Example request

{
  "buyer_id": 42,
  "name": "Monthly plan",
  "value": 9.99,
  "type": "CARD"
}

Response

Subscription created

idinteger
selfstring
reference_idstring nullable
namestring
amountnumber
currencystring
typestring

Payment method type for this subscription.

status'CREATED' | 'ACTIVE' | 'CANCELLED' | 'EXPIRED'
metadataobject nullable
published_atstring date-time nullable
cancelled_atstring date-time nullable
connectionsConnections

Hypermedia links to related resources.

Example response

{
  "currency": "EUR"
}

Changes