Create Subscription

post

https://api.getpinch.com.au/test/subscriptions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

planId

string

required

Plan Id in pln_XXXXXXXXXXXXXX format

payerId

string

required

Payer Id in pyr_XXXXXXXXXXXXXX format

totalAmount

int32

If the plan needs a total amount (percentage based plans) you must supply it here in cents. This will override the end date settings on a recurring plan to end after this total amount is paid.

startDate

date

When the subscription should start. Leave blank for immediately.

surcharge

array of strings

If you wish to pass on the fees for certain payment methods, specify them here. Values can be "bank-account" and/or "credit-card".

surcharge

sourceId

string

Source Id in src_XXXXXXXXX format. If you want to use a specific Source, otherwise a Source will be automatically selected. If the Source is removed the Subscription will no longer be able to complete.

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201201

400400