Skip to navigation
Subscription Creation APIPurchase POST Requests

Purchase POST API

View as Markdown

Creates subscriptions, along with the customer, payment and addresses they need, from a single POST at checkout. See Subscription Creation via Purchase POST for the full payload.

The body is a single create_request field whose value is the JSON payload. URL-encode each string in the payload before sending, so that characters such as +, & and % aren’t misread. Don’t URL-encode the create_request= prefix or the authorization header.

Authentication

x-api-keystring
API Key authentication via header

Request

This endpoint expects an object.
merchant_idstringRequired
merchant public id
merchant_order_idstringRequired
Order ID in your system
og_cart_trackingbooleanOptional

If omitted or true, then session_id is required. Otherwise, session_id is optional.

session_idstringOptional

Session Id, gotten from og_session_id cookie.

userobjectOptional

The customer being created; required fields can be updated by contacting support.

paymentobjectOptional
Required fields can be configured via RC3
productsobjectOptional
The products that this customer bought or subscribed to

Response

200
resultstringOptional
subs_req_idstringOptional

Errors

400
Bad Request Error
403
Forbidden Error