API Reference

Create a subscription

post
https://api.web2wave.com/api/subscription

Create a subscription record in the current project. Unique constraint applies to the combination of (payment_system, pay_system_id, real_payment, project_id).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required

Payment system ID. Known values: 0 = Stripe, 1 = Paddle, 2 = CloudPayments, 3 = PayPal, 4 = Primer, 5 = Hubx, 6 = Solidgate, 7 = Unlimit, 8 = Custom. Use 8 (Custom) for subscriptions created outside integrated payment systems (e.g. manual or custom gateways).

boolean

Production mode (true) or test mode (false).

string
required

ID of the subscription in external payment system.

string | null
string | null
string
required
number
required

Amount in cents.

string
required
date-time | null
boolean
string
required
string
required
string
string | null
date-time | null
date-time | null
integer
integer
integer | null
string | null
integer | null

Projected revenue over 32 days (e.g. in cents).

integer | null

Projected revenue over 62 days (e.g. in cents).

integer | null

Projected revenue over 184 days (e.g. in cents).

integer | null

Projected revenue over 367 days (e.g. in cents).

date-time | null
date-time | null
subscription_invoices
array of objects

Optional. Create invoice records along with the subscription. Each item is attached to the new subscription.

subscription_invoices
Responses

Updated 2 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago