API Reference
Log InContact Us

Create a subscription

post
https://api.neonpay.com/subscriptions

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

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

Unique subscription SKU

string
required
length ≥ 1

Customer-facing subscription name

integer
required
≥ 0

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

uri
required

URL for subscription image

string
enum
required

ISO 4217 currency code

string
enum
Defaults to monthly

Billing frequency

Allowed:
string
required
length ≥ 1

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.

string | null

The display name of the user's account, if available

uri
required

URL to redirect to upon successful signup

uri
required

URL to redirect to upon signup cancellation

uri

The URL of your store

string | null

A reference to this transaction, like an internal purchase ID

string
Defaults to en-US

The user's language, in IETF BCP 47 tag

string
required

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.

Responses

Updated about 1 month 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 about 1 month ago