Skip to main content
POST
Subscribe to a plan

Authorizations

Authorization
string
header
required

Merchant authentication token. Obtained via POST /api/v1/merchant/token/grant. Pass as: Authorization: Bearer

Body

application/json
plan_id
string
required

Plan hash ID

source_customer_id
string<uuid>
required
destination_customer_id
string<uuid>
required
payment_method_id
string<uuid>
required
payment_method_type
enum<string>
required
Available options:
CARD
payment_method_provider
string
required
fee_bearer
enum<string>
required
Available options:
connected_account

Response

Subscription created

msg
string
required

Human-readable message describing the result

Example:

"Subscription created successfully"

data
object
required

Response payload (null on error)