Skip to main content
POST
Set up automatic payment for a service

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Path Parameters

service
string
required

The service ID returned by the billing endpoints.

Example:

7312

Body

application/json

Send a JSON object containing the fields below. Required fields are marked in the schema.

option
enum<string> | null

The value of option.

Available options:
paddle_once,
paddle_subscription,
stripe_once,
stripe_subscription,
paypal_once,
paypal_subscription,
btcpay_once,
nowpayments_once,
null
paypal_account
string<uuid> | null

The value of paypal_account.

Response

The record, as a JSON object. There is no envelope.

The payment setup details needed to enable automatic renewal for a service.

transactionId
string | null
required

The transaction id ID.

Example:

"txn_01m2gcs800msa9tpw20kdrzbgq"

checkoutUrl
string | null
required

The value of checkout_url.

Example:

"https://vps.advinservers.com/services/7398/billing?_ptxn=txn_01m2gcs800msa9tpw20kdrzbgq"

clientToken
string | null
required

The value of client_token.

Example:

"live_7d0b6c1f3e9a24c58b71e2f4d93"

environment
string
required

The value of environment.

Example:

"production"

chargesNow
boolean
required

The value of charges_now.

Example:

false

firstChargeAt
string | null
required

The date and time for first charge at, in UTC.

Example:

"2026-10-11"

resumed
boolean
required

The value of resumed.

Example:

false

active
boolean
required

Autopay is already on, from a saved PayPal account, so there is no page to open.

Example:

true