Start a subscription

put

https://api.revenuehq.dev/applications/{applicationID}/accounts/{accountID}/subscription

Sets up a new subscription for the account. If there is already an active subscription, the request will follow the standard proration rules to determine when the new subscription should start. These considerations can be explicitly overridden in the request itself.

A discount can be applied to this subscription by passing a discount_id, offer_id, or offer_code. However, only one of these fields can be provided. If multiple fields are provided, the request will fail.

Authorized scopes:

owner
admin:full
admin:limited
account:update

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

applicationID

uuid

required

The id of the application.

accountID

uuid

required

The id of the account.

Body Params

force

boolean

If true, the subscription will be created immediately, regardless of any existing subs or payments.

bypass_proration

boolean

If true, the request will NOT attempt to prorate the existing payment. If true, and if there's a current subscription, the current subscription will play out until the end of the current billing period. Thereafter, the new subscription will start.

plan_group_id

uuid

required

The id of the plan group to subscribe.

plan_id

uuid

required

The id of the plan to subscribe.

discount_id

uuid

The id of the discount to apply.

offer_id

uuid

The id of the offer to apply.

offer_code

string

The offer code to apply.

referral

object

external_id

string

An external id to associate with the subscription.

metadata

object

Metadata to associate with the subscription. Key names and values must be strings.

This is ignored by Revenue HQ and will be returned in the API payload exactly as supplied.

billing_system

string

enum

The underlying billing system that will manage the subscription.

Allowed:

Headers

REVHQ-Version

integer

Responses

204

Subscription update successfully

401

Unauthorized

Language

Credentials

Bearer

token

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad request

500Server error