Activate or update subscription

POST/v1/billing/admin/{userId}/subscription

Create or overwrite subscription metadata for a user.

How to call this endpoint

Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.

Path, query, and header parameters

These parameters control which ACP object the endpoint acts on and how the request is processed.

Path parameters
NameLocationTypeRequiredDescription
userIdpathstringYesUser ID
Query parameters
None.

Body schema

Content type: application/json · Required

FieldTypeRequiredDescription
tierbuilder | individual | pro | team | scale | business | enterprise | max | company | corporate | organization | org | enterprise_planYesPaid billing plan ID or a supported legacy plan alias.
lemonSqueezySubscriptionIdstringNo—
appleOriginalTransactionIdstringNo—
sourcelemonsqueezy | appleNo—
periodStartDatestringNo—
periodEndDatestringNo—
organizationIdstringNo—
billingIntervalmonthly | annualNo—
builderSeatsintegerNo—

What the API returns

Each response code below includes the documented payload shape for the ACP API.

200Subscription activated or updatedapplication/json
FieldTypeRequiredDescription
successbooleanNoWhether the request succeeded.
userIdstringNoUser ID.
tierfree | pro | scale | maxNo—
subscriptionStatusstringNo—
subscriptionSourcestringNo—
periodStartDatestringNo—
periodEndDatestringNo—
currentPeriodUsagenumberNo—
Activate or update subscription
Loading...
Response 200
Loading...
See the ACP quickstart and SDK flow