v4

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-04-277127123.7 KB

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 required

Customer ID of the seller.

namestring required

valuenumber required

Recurring charge amount.

typestring required

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

fee_valuenumber

fee_percentnumber

start_datestring date

Date when the subscription starts. Defaults to creation date if not provided.

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": 7485,
  "seller_id": 7485,
  "name": "Subscription Test",
  "value": 10,
  "type": "ADDON"
}

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"
}