get active phase
Copy
curl --request GET \
--url https://api.unprice.dev/v1/customer/{customerId}/getActivePhase \
--header 'Authorization: Bearer <token>'Copy
{
"id": "<string>",
"projectId": "<string>",
"subscriptionId": "<string>",
"planVersionId": "<string>",
"paymentMethodId": "<string>",
"billingAnchor": 123,
"trialEndsAt": 123,
"startAt": 123,
"endAt": 123,
"planVersion": {
"id": "<string>",
"projectId": "<string>",
"createdAtM": 123,
"updatedAtM": 123,
"planId": "<string>",
"description": "<string>",
"latest": true,
"title": "<string>",
"tags": [
"<string>"
],
"active": true,
"status": "draft",
"publishedAt": 123,
"publishedBy": "<string>",
"archived": true,
"archivedAt": 123,
"archivedBy": "<string>",
"paymentProvider": "stripe",
"dueBehaviour": "cancel",
"currency": "USD",
"billingConfig": {
"name": "<string>",
"billingInterval": "month",
"billingIntervalCount": 6,
"planType": "recurring",
"billingAnchor": "dayOfCreation"
},
"whenToBill": "pay_in_advance",
"gracePeriod": 123,
"collectionMethod": "charge_automatically",
"trialDays": 123,
"autoRenew": true,
"metadata": {
"externalId": "<string>"
},
"paymentMethodRequired": true,
"version": 123
},
"customerEntitlements": [
{
"id": "<string>",
"projectId": "<string>",
"createdAtM": 123,
"updatedAtM": 123,
"customerId": "<string>",
"subscriptionId": "<string>",
"featurePlanVersionId": "<string>",
"subscriptionItemId": "<string>",
"subscriptionPhaseId": "<string>",
"limit": 123,
"units": 123,
"usage": "<string>",
"accumulatedUsage": "<string>",
"realtime": true,
"type": "feature",
"validFrom": 123,
"validTo": 123,
"bufferPeriodDays": 123,
"resetedAt": 123,
"active": true,
"isCustom": true,
"lastUsageUpdateAt": 123,
"metadata": {},
"featurePlanVersion": {
"id": "<string>",
"projectId": "<string>",
"createdAtM": 123,
"updatedAtM": 123,
"planVersionId": "<string>",
"featureId": "<string>",
"featureType": "flat",
"config": {
"price": {
"dinero": {
"amount": 123,
"currency": {
"code": "<string>",
"base": 123,
"exponent": 123
},
"scale": 123
},
"displayAmount": "<string>"
},
"tiers": [
{
"unitPrice": {
"dinero": {
"amount": 123,
"currency": {
"code": "<string>",
"base": 123,
"exponent": 123
},
"scale": 123
},
"displayAmount": "<string>"
},
"flatPrice": {
"dinero": {
"amount": 123,
"currency": {
"code": "<string>",
"base": 123,
"exponent": 123
},
"scale": 123
},
"displayAmount": "<string>"
},
"firstUnit": 2,
"lastUnit": 2
}
],
"usageMode": "tier",
"tierMode": "volume",
"units": 2
},
"metadata": {
"stripeProductId": "<string>",
"realtime": true
},
"aggregationMethod": "sum",
"order": 123,
"hidden": true,
"feature": {
"id": "<string>",
"projectId": "<string>",
"createdAtM": 123,
"updatedAtM": 123,
"slug": "<string>",
"code": 123,
"title": "<string>",
"description": "<string>"
},
"defaultQuantity": 1,
"limit": 123
}
}
],
"createdAtM": 123,
"updatedAtM": 123,
"trialDays": 0,
"metadata": {
"note": "<string>",
"reason": "payment_failed"
},
"items": [
{
"id": "<string>",
"projectId": "<string>",
"createdAtM": 123,
"updatedAtM": 123,
"units": 123,
"featurePlanVersionId": "<string>",
"subscriptionPhaseId": "<string>",
"subscriptionId": "<string>"
}
]
}customer
get active phase
Get active phase for a customer
GET
/
v1
/
customer
/
{customerId}
/
getActivePhase
get active phase
Copy
curl --request GET \
--url https://api.unprice.dev/v1/customer/{customerId}/getActivePhase \
--header 'Authorization: Bearer <token>'Copy
{
"id": "<string>",
"projectId": "<string>",
"subscriptionId": "<string>",
"planVersionId": "<string>",
"paymentMethodId": "<string>",
"billingAnchor": 123,
"trialEndsAt": 123,
"startAt": 123,
"endAt": 123,
"planVersion": {
"id": "<string>",
"projectId": "<string>",
"createdAtM": 123,
"updatedAtM": 123,
"planId": "<string>",
"description": "<string>",
"latest": true,
"title": "<string>",
"tags": [
"<string>"
],
"active": true,
"status": "draft",
"publishedAt": 123,
"publishedBy": "<string>",
"archived": true,
"archivedAt": 123,
"archivedBy": "<string>",
"paymentProvider": "stripe",
"dueBehaviour": "cancel",
"currency": "USD",
"billingConfig": {
"name": "<string>",
"billingInterval": "month",
"billingIntervalCount": 6,
"planType": "recurring",
"billingAnchor": "dayOfCreation"
},
"whenToBill": "pay_in_advance",
"gracePeriod": 123,
"collectionMethod": "charge_automatically",
"trialDays": 123,
"autoRenew": true,
"metadata": {
"externalId": "<string>"
},
"paymentMethodRequired": true,
"version": 123
},
"customerEntitlements": [
{
"id": "<string>",
"projectId": "<string>",
"createdAtM": 123,
"updatedAtM": 123,
"customerId": "<string>",
"subscriptionId": "<string>",
"featurePlanVersionId": "<string>",
"subscriptionItemId": "<string>",
"subscriptionPhaseId": "<string>",
"limit": 123,
"units": 123,
"usage": "<string>",
"accumulatedUsage": "<string>",
"realtime": true,
"type": "feature",
"validFrom": 123,
"validTo": 123,
"bufferPeriodDays": 123,
"resetedAt": 123,
"active": true,
"isCustom": true,
"lastUsageUpdateAt": 123,
"metadata": {},
"featurePlanVersion": {
"id": "<string>",
"projectId": "<string>",
"createdAtM": 123,
"updatedAtM": 123,
"planVersionId": "<string>",
"featureId": "<string>",
"featureType": "flat",
"config": {
"price": {
"dinero": {
"amount": 123,
"currency": {
"code": "<string>",
"base": 123,
"exponent": 123
},
"scale": 123
},
"displayAmount": "<string>"
},
"tiers": [
{
"unitPrice": {
"dinero": {
"amount": 123,
"currency": {
"code": "<string>",
"base": 123,
"exponent": 123
},
"scale": 123
},
"displayAmount": "<string>"
},
"flatPrice": {
"dinero": {
"amount": 123,
"currency": {
"code": "<string>",
"base": 123,
"exponent": 123
},
"scale": 123
},
"displayAmount": "<string>"
},
"firstUnit": 2,
"lastUnit": 2
}
],
"usageMode": "tier",
"tierMode": "volume",
"units": 2
},
"metadata": {
"stripeProductId": "<string>",
"realtime": true
},
"aggregationMethod": "sum",
"order": 123,
"hidden": true,
"feature": {
"id": "<string>",
"projectId": "<string>",
"createdAtM": 123,
"updatedAtM": 123,
"slug": "<string>",
"code": 123,
"title": "<string>",
"description": "<string>"
},
"defaultQuantity": 1,
"limit": 123
}
}
],
"createdAtM": 123,
"updatedAtM": 123,
"trialDays": 0,
"metadata": {
"note": "<string>",
"reason": "payment_failed"
},
"items": [
{
"id": "<string>",
"projectId": "<string>",
"createdAtM": 123,
"updatedAtM": 123,
"units": 123,
"featurePlanVersionId": "<string>",
"subscriptionPhaseId": "<string>",
"subscriptionId": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The customer ID
Example:
"cus_1H7KQFLr7RepUyQBKdnvY"
Response
The result of the get active phase
Maximum string length:
36Maximum string length:
36Maximum string length:
36Minimum string length:
1Show child attributes
Show child attributes
Maximum string length:
36Maximum string length:
36Maximum string length:
36Maximum string length:
50Available options:
draft, published Maximum string length:
36Maximum string length:
36Available options:
stripe, square Available options:
cancel, downgrade Available options:
USD, EUR The billing configuration for the plan version
Show child attributes
Show child attributes
Minimum string length:
1Available options:
month, year, day, minute, onetime Required range:
1 <= x <= 12Available options:
recurring, onetime Days of the month. Pick a number between 1 and 31, if the month has less days, it will be the last day of the month
Required range:
1 <= x <= 31Available options:
pay_in_advance, pay_in_arrear Available options:
charge_automatically, send_invoice Show child attributes
Show child attributes
Maximum string length:
36Maximum string length:
36Maximum string length:
36Maximum string length:
36Maximum string length:
36Maximum string length:
36Maximum string length:
36Available options:
feature, addon Show child attributes
Show child attributes
Maximum string length:
36Maximum string length:
36Maximum string length:
36Maximum string length:
36Available options:
flat, tier, package, usage - Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The amount of the dinero object
Show child attributes
Show child attributes
The currency code of the dinero object
The base of the dinero object
The exponent of the dinero object
The scale of the dinero object
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The amount of the dinero object
Show child attributes
Show child attributes
The currency code of the dinero object
The base of the dinero object
customerEntitlements.featurePlanVersion.config.tiers.unitPrice.dinero.currency.exponent
number
required
The exponent of the dinero object
The scale of the dinero object
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The amount of the dinero object
Show child attributes
Show child attributes
The currency code of the dinero object
The base of the dinero object
customerEntitlements.featurePlanVersion.config.tiers.flatPrice.dinero.currency.exponent
number
required
The exponent of the dinero object
The scale of the dinero object
Required range:
x >= 1Required range:
x >= 1Available options:
tier, package, unit Available options:
volume, graduated Required range:
x >= 1Available options:
sum, sum_all, last_during_period, count, count_all, max, max_all Show child attributes
Show child attributes
Maximum string length:
36Maximum string length:
36Maximum string length:
50Required range:
x >= 0Show child attributes
Show child attributes
Note about the subscription phase
Reason for the subscription phase
Available options:
payment_failed, invoice_voided, payment_pending, payment_method_not_found, policy_violation, pending_cancellation, invoice_failed, invoice_pending, payment_received, pending_change, pending_expiration, trial_ended, user_requested, admin_requested, ending, renewed, cancelled, auto_renew_disabled, customer_signout Show child attributes
Show child attributes
Maximum string length:
36Maximum string length:
36Maximum string length:
36Maximum string length:
36Maximum string length:
36⌘I