Synchronize a provider subscription source
POST
/v1/billing/admin/{userId}/provider-subscriptionRecords a test- or production-mode Lemon Squeezy subscription independently and recomputes the effective entitlement for the current deployment stage.
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
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| userId | path | string | Yes | User ID |
Query parameters
None.
Body schema
Content type: application/json · Required
| Field | Type | Required | Description |
|---|---|---|---|
| provider | lemonsqueezy | No | — |
| providerMode | test | production | Yes | — |
| providerSubscriptionId | string | Yes | — |
| lemonSqueezySubscriptionId | string | No | Deprecated alias for `providerSubscriptionId`. |
| providerCustomerId | string | No | — |
| tier | builder | team | business | enterprise | pro | scale | max | Yes | — |
| planId | string | No | Deprecated alias for `tier`. |
| status | trialing | active | past_due | canceled | cancelled | expired | Yes | Current lifecycle status. |
| organizationId | string | No | — |
| periodStartDate | string | No | — |
| periodEndDate | string | No | — |
| billingInterval | monthly | annual | No | — |
| builderSeats | integer | No | — |
| resetPeriodUsage | boolean | No | — |
| productionEligible | boolean | No | Explicitly approves a test-mode source as a production fallback. Reserved for grandfathered or internal subscriptions. |
| eventName | string | No | — |
| variantId | string | No | — |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Provider source stored and stage entitlement projectedapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| success | boolean | No | Whether the request succeeded. |
| userId | string | No | User ID. |
| deploymentStage | dev | cons | prod | No | — |
| recognizedSourceCount | integer | No | — |
| tier | string | No | — |
| subscriptionStatus | string | No | — |
| organizationId | string | No | — |
| planId | string | No | — |
| source | object | No | — |
| effectiveSource | object | No | — |
| organizationSubscription | object | No | — |
400Invalid requestapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | Yes | — |
| message | string | No | Message text. |
| code | string | No | — |
Synchronize a provider subscription source
Loading...
Response 200
Loading...