Create a subscription

Create a subscription. Once the subscription is created, redirect the user to the returnUrl.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 100
^[A-Za-z0-9 ._:@|+-]+$

Unique subscription SKU

string
required
length between 1 and 255

Customer-facing subscription name

int64
required
0 to 9007199254740991

Subscription price, expressed in 100x the base unit of the currency; read more about prices here

url
required
length ≤ 2048

URL for subscription image

string
enum
required

ISO 4217 currency code

string
enum
Defaults to monthly

Billing frequency

Allowed:
string
required
length ≤ 100
^[A-Za-z0-9._:@-]+$

A unique identifier for the player or account in your system who should receive the purchased items. Neon includes this value in fulfillment webhooks so you can credit the correct user. Up to 100 letters, digits and -, ., :, @ or _.

string | null

The display name of the user's account, if available. At most 100 characters.

url | null

URL to redirect to upon completion of the subscription creation flow.

url
length ≤ 2048

The URL of your store

Identifier | Null

A reference to this transaction, like an internal purchase ID

string
length ≤ 100
Defaults to en-US

The user's language, in IETF BCP 47 tag

string
required
length ≤ 100

The physical location of the player as an ISO 3166-1 code; also used to derive currency. See International Support, as well as the note in Subscriptions, for a full list of supported countries.

externalMetadata
object | null

Arbitrary JSON object for tracking metadata used in analytics and webhooks.
DO NOT include sensitive data or authentication tokens.
At most 50 top-level keys, 10 levels deep and 4,096 bytes as JSON.

Headers
string

Makes the request safe to retry. 1-255 visible ASCII characters, for example a UUID. See Idempotent requests.

Responses

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