API Documentation
Purchases
Invoice Line Items
Invoices
Pricing Models
API Keys
Subscriptions
Payment Methods
Usage Events
Product Features
Get Billing Details
Copy
Ask AI
curl --request GET \
--url https://app.flowglad.com/api/v1/customers/{externalId}/billing \
--header 'Authorization: <api-key>'Copy
Ask AI
{
"customer": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"email": "<string>",
"name": "<string>",
"invoiceNumberBase": "<string>",
"archived": true,
"logoURL": "<string>",
"iconURL": "<string>",
"domain": "<string>",
"externalId": "<string>",
"userId": "<string>",
"pricingModelId": "<string>",
"billingAddress": {
"address": {
"country": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>"
},
"name": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "[email protected]",
"phone": "<string>"
}
},
"subscriptions": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"startDate": 0,
"customerId": "<string>",
"organizationId": "<string>",
"status": "active",
"defaultPaymentMethodId": "<string>",
"backupPaymentMethodId": "<string>",
"trialEnd": "<unknown>",
"currentBillingPeriodStart": "<unknown>",
"currentBillingPeriodEnd": "<unknown>",
"cancellationReason": "<string>",
"replacedBySubscriptionId": "<string>",
"isFreePlan": true,
"priceId": "<string>",
"runBillingAtPeriodStart": true,
"interval": "<unknown>",
"intervalCount": "<unknown>",
"billingCycleAnchorDate": "<unknown>",
"name": "<string>",
"renews": true,
"current": true,
"subscriptionItems": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"subscriptionId": "<string>",
"name": "<string>",
"addedDate": 0,
"priceId": "<string>",
"unitPrice": 4503599627370495,
"quantity": 123,
"type": "<string>",
"externalId": "<string>",
"price": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "<string>",
"isDefault": true,
"unitPrice": 4503599627370495,
"usageEventsPerUnit": "<unknown>",
"productId": "<string>",
"active": true,
"currency": "USD",
"slug": "<string>",
"usageMeterId": "<unknown>",
"trialPeriodDays": 4503599627370495
},
"metadata": {},
"expiredAt": 0
}
],
"metadata": {},
"canceledAt": 0,
"cancelScheduledAt": 0,
"experimental": {
"featureItems": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"subscriptionItemId": "<string>",
"featureId": "<string>",
"type": "<string>",
"manuallyCreated": true,
"name": "<string>",
"slug": "<string>",
"productFeatureId": "<string>",
"amount": "<unknown>",
"usageMeterId": "<unknown>",
"renewalFrequency": "<unknown>",
"expiredAt": 0,
"detachedAt": 0,
"detachedReason": "<string>"
}
],
"usageMeterBalances": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"name": "<string>",
"pricingModelId": "<string>",
"slug": "<string>",
"aggregationType": "sum",
"availableBalance": 123,
"subscriptionId": "<string>"
}
]
}
}
],
"invoices": [
{
"invoice": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"purchaseId": "<string>",
"invoiceNumber": "<string>",
"invoiceDate": 0,
"customerId": "<string>",
"organizationId": "<string>",
"status": "draft",
"billingRunId": "<string>",
"ownerMembershipId": "<string>",
"memo": "<string>",
"bankPaymentOnly": true,
"type": "<string>",
"currency": "USD",
"taxAmount": -1,
"subtotal": -1,
"taxState": "<string>",
"taxRatePercentage": "<string>",
"applicationFee": -1,
"billingPeriodId": "<unknown>",
"dueDate": 0,
"subscriptionId": "<unknown>",
"billingPeriodStartDate": "<unknown>",
"billingPeriodEndDate": "<unknown>",
"pdfURL": "<string>",
"receiptPdfURL": "<string>",
"taxType": "amusement_tax",
"taxCountry": "AD"
},
"invoiceLineItems": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"invoiceId": "<string>",
"quantity": -1,
"priceId": "<string>",
"description": "<string>",
"price": -1,
"type": "<string>",
"ledgerAccountId": "<unknown>",
"ledgerAccountCredit": "<unknown>"
}
]
}
],
"paymentMethods": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"customerId": "<string>",
"billingDetails": {
"address": {
"country": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"address": {
"country": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>"
}
},
"name": "<string>",
"email": "<string>"
},
"type": "card",
"default": true,
"paymentMethodData": {},
"metadata": {}
}
],
"purchases": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"name": "<string>",
"status": "open",
"customerId": "<string>",
"organizationId": "<string>",
"priceId": "<string>",
"quantity": 123,
"priceType": "<string>",
"trialPeriodDays": 4503599627370495,
"pricePerBillingCycle": 123,
"intervalUnit": "day",
"intervalCount": 123,
"firstInvoiceValue": 4503599627370495,
"totalPurchaseValue": "<unknown>",
"bankPaymentOnly": true,
"proposal": "<string>",
"archived": true,
"position": 123,
"billingCycleAnchor": 0,
"purchaseDate": 0,
"endDate": 0,
"billingAddress": {
"address": {
"country": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>"
},
"name": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "[email protected]",
"phone": "<string>"
},
"metadata": {}
}
],
"catalog": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"isDefault": true,
"name": "<string>",
"products": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"name": "<string>",
"description": "<string>",
"imageURL": "<string>",
"organizationId": "<string>",
"active": true,
"singularQuantityLabel": "<string>",
"pluralQuantityLabel": "<string>",
"pricingModelId": "<string>",
"default": true,
"slug": "<string>",
"prices": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "<string>",
"isDefault": true,
"unitPrice": 4503599627370495,
"usageEventsPerUnit": "<unknown>",
"productId": "<string>",
"active": true,
"currency": "USD",
"slug": "<string>",
"usageMeterId": "<unknown>",
"trialPeriodDays": 4503599627370495
}
],
"defaultPrice": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "<string>",
"isDefault": true,
"unitPrice": 4503599627370495,
"usageEventsPerUnit": "<unknown>",
"productId": "<string>",
"active": true,
"currency": "USD",
"slug": "<string>",
"usageMeterId": "<unknown>",
"trialPeriodDays": 4503599627370495
},
"features": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"type": "<string>",
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"pricingModelId": "<string>",
"active": true,
"amount": "<unknown>",
"usageMeterId": "<unknown>",
"renewalFrequency": "<unknown>"
}
]
}
],
"usageMeters": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"name": "<string>",
"pricingModelId": "<string>",
"slug": "<string>",
"aggregationType": "sum"
}
],
"defaultProduct": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"name": "<string>",
"description": "<string>",
"imageURL": "<string>",
"organizationId": "<string>",
"active": true,
"singularQuantityLabel": "<string>",
"pluralQuantityLabel": "<string>",
"pricingModelId": "<string>",
"default": true,
"slug": "<string>",
"prices": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "<string>",
"isDefault": true,
"unitPrice": 4503599627370495,
"usageEventsPerUnit": "<unknown>",
"productId": "<string>",
"active": true,
"currency": "USD",
"slug": "<string>",
"usageMeterId": "<unknown>",
"trialPeriodDays": 4503599627370495
}
],
"defaultPrice": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "<string>",
"isDefault": true,
"unitPrice": 4503599627370495,
"usageEventsPerUnit": "<unknown>",
"productId": "<string>",
"active": true,
"currency": "USD",
"slug": "<string>",
"usageMeterId": "<unknown>",
"trialPeriodDays": 4503599627370495
},
"features": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"type": "<string>",
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"pricingModelId": "<string>",
"active": true,
"amount": "<unknown>",
"usageMeterId": "<unknown>",
"renewalFrequency": "<unknown>"
}
]
}
},
"pricingModel": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"isDefault": true,
"name": "<string>",
"products": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"name": "<string>",
"description": "<string>",
"imageURL": "<string>",
"organizationId": "<string>",
"active": true,
"singularQuantityLabel": "<string>",
"pluralQuantityLabel": "<string>",
"pricingModelId": "<string>",
"default": true,
"slug": "<string>",
"prices": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "<string>",
"isDefault": true,
"unitPrice": 4503599627370495,
"usageEventsPerUnit": "<unknown>",
"productId": "<string>",
"active": true,
"currency": "USD",
"slug": "<string>",
"usageMeterId": "<unknown>",
"trialPeriodDays": 4503599627370495
}
],
"defaultPrice": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "<string>",
"isDefault": true,
"unitPrice": 4503599627370495,
"usageEventsPerUnit": "<unknown>",
"productId": "<string>",
"active": true,
"currency": "USD",
"slug": "<string>",
"usageMeterId": "<unknown>",
"trialPeriodDays": 4503599627370495
},
"features": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"type": "<string>",
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"pricingModelId": "<string>",
"active": true,
"amount": "<unknown>",
"usageMeterId": "<unknown>",
"renewalFrequency": "<unknown>"
}
]
}
],
"usageMeters": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"name": "<string>",
"pricingModelId": "<string>",
"slug": "<string>",
"aggregationType": "sum"
}
],
"defaultProduct": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"name": "<string>",
"description": "<string>",
"imageURL": "<string>",
"organizationId": "<string>",
"active": true,
"singularQuantityLabel": "<string>",
"pluralQuantityLabel": "<string>",
"pricingModelId": "<string>",
"default": true,
"slug": "<string>",
"prices": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "<string>",
"isDefault": true,
"unitPrice": 4503599627370495,
"usageEventsPerUnit": "<unknown>",
"productId": "<string>",
"active": true,
"currency": "USD",
"slug": "<string>",
"usageMeterId": "<unknown>",
"trialPeriodDays": 4503599627370495
}
],
"defaultPrice": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "<string>",
"isDefault": true,
"unitPrice": 4503599627370495,
"usageEventsPerUnit": "<unknown>",
"productId": "<string>",
"active": true,
"currency": "USD",
"slug": "<string>",
"usageMeterId": "<unknown>",
"trialPeriodDays": 4503599627370495
},
"features": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"type": "<string>",
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"pricingModelId": "<string>",
"active": true,
"amount": "<unknown>",
"usageMeterId": "<unknown>",
"renewalFrequency": "<unknown>"
}
]
}
},
"billingPortalUrl": "<string>",
"currentSubscriptions": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"startDate": 0,
"customerId": "<string>",
"organizationId": "<string>",
"status": "active",
"defaultPaymentMethodId": "<string>",
"backupPaymentMethodId": "<string>",
"trialEnd": "<unknown>",
"currentBillingPeriodStart": "<unknown>",
"currentBillingPeriodEnd": "<unknown>",
"cancellationReason": "<string>",
"replacedBySubscriptionId": "<string>",
"isFreePlan": true,
"priceId": "<string>",
"runBillingAtPeriodStart": true,
"interval": "<unknown>",
"intervalCount": "<unknown>",
"billingCycleAnchorDate": "<unknown>",
"name": "<string>",
"renews": true,
"current": true,
"subscriptionItems": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"subscriptionId": "<string>",
"name": "<string>",
"addedDate": 0,
"priceId": "<string>",
"unitPrice": 4503599627370495,
"quantity": 123,
"type": "<string>",
"externalId": "<string>",
"price": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "<string>",
"isDefault": true,
"unitPrice": 4503599627370495,
"usageEventsPerUnit": "<unknown>",
"productId": "<string>",
"active": true,
"currency": "USD",
"slug": "<string>",
"usageMeterId": "<unknown>",
"trialPeriodDays": 4503599627370495
},
"metadata": {},
"expiredAt": 0
}
],
"metadata": {},
"canceledAt": 0,
"cancelScheduledAt": 0,
"experimental": {
"featureItems": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"subscriptionItemId": "<string>",
"featureId": "<string>",
"type": "<string>",
"manuallyCreated": true,
"name": "<string>",
"slug": "<string>",
"productFeatureId": "<string>",
"amount": "<unknown>",
"usageMeterId": "<unknown>",
"renewalFrequency": "<unknown>",
"expiredAt": 0,
"detachedAt": 0,
"detachedReason": "<string>"
}
],
"usageMeterBalances": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"name": "<string>",
"pricingModelId": "<string>",
"slug": "<string>",
"aggregationType": "sum",
"availableBalance": 123,
"subscriptionId": "<string>"
}
]
}
}
],
"currentSubscription": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"startDate": 0,
"customerId": "<string>",
"organizationId": "<string>",
"status": "active",
"defaultPaymentMethodId": "<string>",
"backupPaymentMethodId": "<string>",
"trialEnd": "<unknown>",
"currentBillingPeriodStart": "<unknown>",
"currentBillingPeriodEnd": "<unknown>",
"cancellationReason": "<string>",
"replacedBySubscriptionId": "<string>",
"isFreePlan": true,
"priceId": "<string>",
"runBillingAtPeriodStart": true,
"interval": "<unknown>",
"intervalCount": "<unknown>",
"billingCycleAnchorDate": "<unknown>",
"name": "<string>",
"renews": true,
"current": true,
"subscriptionItems": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"subscriptionId": "<string>",
"name": "<string>",
"addedDate": 0,
"priceId": "<string>",
"unitPrice": 4503599627370495,
"quantity": 123,
"type": "<string>",
"externalId": "<string>",
"price": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "<string>",
"isDefault": true,
"unitPrice": 4503599627370495,
"usageEventsPerUnit": "<unknown>",
"productId": "<string>",
"active": true,
"currency": "USD",
"slug": "<string>",
"usageMeterId": "<unknown>",
"trialPeriodDays": 4503599627370495
},
"metadata": {},
"expiredAt": 0
}
],
"metadata": {},
"canceledAt": 0,
"cancelScheduledAt": 0,
"experimental": {
"featureItems": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"subscriptionItemId": "<string>",
"featureId": "<string>",
"type": "<string>",
"manuallyCreated": true,
"name": "<string>",
"slug": "<string>",
"productFeatureId": "<string>",
"amount": "<unknown>",
"usageMeterId": "<unknown>",
"renewalFrequency": "<unknown>",
"expiredAt": 0,
"detachedAt": 0,
"detachedReason": "<string>"
}
],
"usageMeterBalances": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"name": "<string>",
"pricingModelId": "<string>",
"slug": "<string>",
"aggregationType": "sum",
"availableBalance": 123,
"subscriptionId": "<string>"
}
]
}
}
}Customer
Get Billing Details
GET
/
api
/
v1
/
customers
/
{externalId}
/
billing
Get Billing Details
Copy
Ask AI
curl --request GET \
--url https://app.flowglad.com/api/v1/customers/{externalId}/billing \
--header 'Authorization: <api-key>'Copy
Ask AI
{
"customer": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"email": "<string>",
"name": "<string>",
"invoiceNumberBase": "<string>",
"archived": true,
"logoURL": "<string>",
"iconURL": "<string>",
"domain": "<string>",
"externalId": "<string>",
"userId": "<string>",
"pricingModelId": "<string>",
"billingAddress": {
"address": {
"country": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>"
},
"name": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "[email protected]",
"phone": "<string>"
}
},
"subscriptions": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"startDate": 0,
"customerId": "<string>",
"organizationId": "<string>",
"status": "active",
"defaultPaymentMethodId": "<string>",
"backupPaymentMethodId": "<string>",
"trialEnd": "<unknown>",
"currentBillingPeriodStart": "<unknown>",
"currentBillingPeriodEnd": "<unknown>",
"cancellationReason": "<string>",
"replacedBySubscriptionId": "<string>",
"isFreePlan": true,
"priceId": "<string>",
"runBillingAtPeriodStart": true,
"interval": "<unknown>",
"intervalCount": "<unknown>",
"billingCycleAnchorDate": "<unknown>",
"name": "<string>",
"renews": true,
"current": true,
"subscriptionItems": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"subscriptionId": "<string>",
"name": "<string>",
"addedDate": 0,
"priceId": "<string>",
"unitPrice": 4503599627370495,
"quantity": 123,
"type": "<string>",
"externalId": "<string>",
"price": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "<string>",
"isDefault": true,
"unitPrice": 4503599627370495,
"usageEventsPerUnit": "<unknown>",
"productId": "<string>",
"active": true,
"currency": "USD",
"slug": "<string>",
"usageMeterId": "<unknown>",
"trialPeriodDays": 4503599627370495
},
"metadata": {},
"expiredAt": 0
}
],
"metadata": {},
"canceledAt": 0,
"cancelScheduledAt": 0,
"experimental": {
"featureItems": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"subscriptionItemId": "<string>",
"featureId": "<string>",
"type": "<string>",
"manuallyCreated": true,
"name": "<string>",
"slug": "<string>",
"productFeatureId": "<string>",
"amount": "<unknown>",
"usageMeterId": "<unknown>",
"renewalFrequency": "<unknown>",
"expiredAt": 0,
"detachedAt": 0,
"detachedReason": "<string>"
}
],
"usageMeterBalances": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"name": "<string>",
"pricingModelId": "<string>",
"slug": "<string>",
"aggregationType": "sum",
"availableBalance": 123,
"subscriptionId": "<string>"
}
]
}
}
],
"invoices": [
{
"invoice": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"purchaseId": "<string>",
"invoiceNumber": "<string>",
"invoiceDate": 0,
"customerId": "<string>",
"organizationId": "<string>",
"status": "draft",
"billingRunId": "<string>",
"ownerMembershipId": "<string>",
"memo": "<string>",
"bankPaymentOnly": true,
"type": "<string>",
"currency": "USD",
"taxAmount": -1,
"subtotal": -1,
"taxState": "<string>",
"taxRatePercentage": "<string>",
"applicationFee": -1,
"billingPeriodId": "<unknown>",
"dueDate": 0,
"subscriptionId": "<unknown>",
"billingPeriodStartDate": "<unknown>",
"billingPeriodEndDate": "<unknown>",
"pdfURL": "<string>",
"receiptPdfURL": "<string>",
"taxType": "amusement_tax",
"taxCountry": "AD"
},
"invoiceLineItems": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"invoiceId": "<string>",
"quantity": -1,
"priceId": "<string>",
"description": "<string>",
"price": -1,
"type": "<string>",
"ledgerAccountId": "<unknown>",
"ledgerAccountCredit": "<unknown>"
}
]
}
],
"paymentMethods": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"customerId": "<string>",
"billingDetails": {
"address": {
"country": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"address": {
"country": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>"
}
},
"name": "<string>",
"email": "<string>"
},
"type": "card",
"default": true,
"paymentMethodData": {},
"metadata": {}
}
],
"purchases": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"name": "<string>",
"status": "open",
"customerId": "<string>",
"organizationId": "<string>",
"priceId": "<string>",
"quantity": 123,
"priceType": "<string>",
"trialPeriodDays": 4503599627370495,
"pricePerBillingCycle": 123,
"intervalUnit": "day",
"intervalCount": 123,
"firstInvoiceValue": 4503599627370495,
"totalPurchaseValue": "<unknown>",
"bankPaymentOnly": true,
"proposal": "<string>",
"archived": true,
"position": 123,
"billingCycleAnchor": 0,
"purchaseDate": 0,
"endDate": 0,
"billingAddress": {
"address": {
"country": "<string>",
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>"
},
"name": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "[email protected]",
"phone": "<string>"
},
"metadata": {}
}
],
"catalog": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"isDefault": true,
"name": "<string>",
"products": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"name": "<string>",
"description": "<string>",
"imageURL": "<string>",
"organizationId": "<string>",
"active": true,
"singularQuantityLabel": "<string>",
"pluralQuantityLabel": "<string>",
"pricingModelId": "<string>",
"default": true,
"slug": "<string>",
"prices": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "<string>",
"isDefault": true,
"unitPrice": 4503599627370495,
"usageEventsPerUnit": "<unknown>",
"productId": "<string>",
"active": true,
"currency": "USD",
"slug": "<string>",
"usageMeterId": "<unknown>",
"trialPeriodDays": 4503599627370495
}
],
"defaultPrice": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "<string>",
"isDefault": true,
"unitPrice": 4503599627370495,
"usageEventsPerUnit": "<unknown>",
"productId": "<string>",
"active": true,
"currency": "USD",
"slug": "<string>",
"usageMeterId": "<unknown>",
"trialPeriodDays": 4503599627370495
},
"features": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"type": "<string>",
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"pricingModelId": "<string>",
"active": true,
"amount": "<unknown>",
"usageMeterId": "<unknown>",
"renewalFrequency": "<unknown>"
}
]
}
],
"usageMeters": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"name": "<string>",
"pricingModelId": "<string>",
"slug": "<string>",
"aggregationType": "sum"
}
],
"defaultProduct": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"name": "<string>",
"description": "<string>",
"imageURL": "<string>",
"organizationId": "<string>",
"active": true,
"singularQuantityLabel": "<string>",
"pluralQuantityLabel": "<string>",
"pricingModelId": "<string>",
"default": true,
"slug": "<string>",
"prices": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "<string>",
"isDefault": true,
"unitPrice": 4503599627370495,
"usageEventsPerUnit": "<unknown>",
"productId": "<string>",
"active": true,
"currency": "USD",
"slug": "<string>",
"usageMeterId": "<unknown>",
"trialPeriodDays": 4503599627370495
}
],
"defaultPrice": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "<string>",
"isDefault": true,
"unitPrice": 4503599627370495,
"usageEventsPerUnit": "<unknown>",
"productId": "<string>",
"active": true,
"currency": "USD",
"slug": "<string>",
"usageMeterId": "<unknown>",
"trialPeriodDays": 4503599627370495
},
"features": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"type": "<string>",
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"pricingModelId": "<string>",
"active": true,
"amount": "<unknown>",
"usageMeterId": "<unknown>",
"renewalFrequency": "<unknown>"
}
]
}
},
"pricingModel": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"isDefault": true,
"name": "<string>",
"products": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"name": "<string>",
"description": "<string>",
"imageURL": "<string>",
"organizationId": "<string>",
"active": true,
"singularQuantityLabel": "<string>",
"pluralQuantityLabel": "<string>",
"pricingModelId": "<string>",
"default": true,
"slug": "<string>",
"prices": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "<string>",
"isDefault": true,
"unitPrice": 4503599627370495,
"usageEventsPerUnit": "<unknown>",
"productId": "<string>",
"active": true,
"currency": "USD",
"slug": "<string>",
"usageMeterId": "<unknown>",
"trialPeriodDays": 4503599627370495
}
],
"defaultPrice": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "<string>",
"isDefault": true,
"unitPrice": 4503599627370495,
"usageEventsPerUnit": "<unknown>",
"productId": "<string>",
"active": true,
"currency": "USD",
"slug": "<string>",
"usageMeterId": "<unknown>",
"trialPeriodDays": 4503599627370495
},
"features": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"type": "<string>",
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"pricingModelId": "<string>",
"active": true,
"amount": "<unknown>",
"usageMeterId": "<unknown>",
"renewalFrequency": "<unknown>"
}
]
}
],
"usageMeters": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"name": "<string>",
"pricingModelId": "<string>",
"slug": "<string>",
"aggregationType": "sum"
}
],
"defaultProduct": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"name": "<string>",
"description": "<string>",
"imageURL": "<string>",
"organizationId": "<string>",
"active": true,
"singularQuantityLabel": "<string>",
"pluralQuantityLabel": "<string>",
"pricingModelId": "<string>",
"default": true,
"slug": "<string>",
"prices": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "<string>",
"isDefault": true,
"unitPrice": 4503599627370495,
"usageEventsPerUnit": "<unknown>",
"productId": "<string>",
"active": true,
"currency": "USD",
"slug": "<string>",
"usageMeterId": "<unknown>",
"trialPeriodDays": 4503599627370495
}
],
"defaultPrice": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "<string>",
"isDefault": true,
"unitPrice": 4503599627370495,
"usageEventsPerUnit": "<unknown>",
"productId": "<string>",
"active": true,
"currency": "USD",
"slug": "<string>",
"usageMeterId": "<unknown>",
"trialPeriodDays": 4503599627370495
},
"features": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"type": "<string>",
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"pricingModelId": "<string>",
"active": true,
"amount": "<unknown>",
"usageMeterId": "<unknown>",
"renewalFrequency": "<unknown>"
}
]
}
},
"billingPortalUrl": "<string>",
"currentSubscriptions": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"startDate": 0,
"customerId": "<string>",
"organizationId": "<string>",
"status": "active",
"defaultPaymentMethodId": "<string>",
"backupPaymentMethodId": "<string>",
"trialEnd": "<unknown>",
"currentBillingPeriodStart": "<unknown>",
"currentBillingPeriodEnd": "<unknown>",
"cancellationReason": "<string>",
"replacedBySubscriptionId": "<string>",
"isFreePlan": true,
"priceId": "<string>",
"runBillingAtPeriodStart": true,
"interval": "<unknown>",
"intervalCount": "<unknown>",
"billingCycleAnchorDate": "<unknown>",
"name": "<string>",
"renews": true,
"current": true,
"subscriptionItems": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"subscriptionId": "<string>",
"name": "<string>",
"addedDate": 0,
"priceId": "<string>",
"unitPrice": 4503599627370495,
"quantity": 123,
"type": "<string>",
"externalId": "<string>",
"price": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "<string>",
"isDefault": true,
"unitPrice": 4503599627370495,
"usageEventsPerUnit": "<unknown>",
"productId": "<string>",
"active": true,
"currency": "USD",
"slug": "<string>",
"usageMeterId": "<unknown>",
"trialPeriodDays": 4503599627370495
},
"metadata": {},
"expiredAt": 0
}
],
"metadata": {},
"canceledAt": 0,
"cancelScheduledAt": 0,
"experimental": {
"featureItems": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"subscriptionItemId": "<string>",
"featureId": "<string>",
"type": "<string>",
"manuallyCreated": true,
"name": "<string>",
"slug": "<string>",
"productFeatureId": "<string>",
"amount": "<unknown>",
"usageMeterId": "<unknown>",
"renewalFrequency": "<unknown>",
"expiredAt": 0,
"detachedAt": 0,
"detachedReason": "<string>"
}
],
"usageMeterBalances": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"name": "<string>",
"pricingModelId": "<string>",
"slug": "<string>",
"aggregationType": "sum",
"availableBalance": 123,
"subscriptionId": "<string>"
}
]
}
}
],
"currentSubscription": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"startDate": 0,
"customerId": "<string>",
"organizationId": "<string>",
"status": "active",
"defaultPaymentMethodId": "<string>",
"backupPaymentMethodId": "<string>",
"trialEnd": "<unknown>",
"currentBillingPeriodStart": "<unknown>",
"currentBillingPeriodEnd": "<unknown>",
"cancellationReason": "<string>",
"replacedBySubscriptionId": "<string>",
"isFreePlan": true,
"priceId": "<string>",
"runBillingAtPeriodStart": true,
"interval": "<unknown>",
"intervalCount": "<unknown>",
"billingCycleAnchorDate": "<unknown>",
"name": "<string>",
"renews": true,
"current": true,
"subscriptionItems": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"subscriptionId": "<string>",
"name": "<string>",
"addedDate": 0,
"priceId": "<string>",
"unitPrice": 4503599627370495,
"quantity": 123,
"type": "<string>",
"externalId": "<string>",
"price": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "<string>",
"isDefault": true,
"unitPrice": 4503599627370495,
"usageEventsPerUnit": "<unknown>",
"productId": "<string>",
"active": true,
"currency": "USD",
"slug": "<string>",
"usageMeterId": "<unknown>",
"trialPeriodDays": 4503599627370495
},
"metadata": {},
"expiredAt": 0
}
],
"metadata": {},
"canceledAt": 0,
"cancelScheduledAt": 0,
"experimental": {
"featureItems": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"subscriptionItemId": "<string>",
"featureId": "<string>",
"type": "<string>",
"manuallyCreated": true,
"name": "<string>",
"slug": "<string>",
"productFeatureId": "<string>",
"amount": "<unknown>",
"usageMeterId": "<unknown>",
"renewalFrequency": "<unknown>",
"expiredAt": 0,
"detachedAt": 0,
"detachedReason": "<string>"
}
],
"usageMeterBalances": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"organizationId": "<string>",
"name": "<string>",
"pricingModelId": "<string>",
"slug": "<string>",
"aggregationType": "sum",
"availableBalance": 123,
"subscriptionId": "<string>"
}
]
}
}
}Authorizations
Path Parameters
The ID of the customer, as defined in your application
Response
Successful response
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes
Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Available options:
active, canceled, credit_trial Omitted.
Omitted.
Omitted.
Omitted.
Omitted.
Omitted.
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991A positive integer
Required range:
0 < x <= 9007199254740991A positive integer
Required range:
x <= 9007199254740991Allowed value:
"static"- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Available options:
day, week, month, year A positive integer
Required range:
x <= 9007199254740991Allowed value:
"subscription"Whether or not this price is the default price for the product.
The price per unit. This should be in the smallest unit of the currency. For example, if the currency is USD, GBP, CAD, EUR or SGD, the price should be in cents.
Required range:
0 < x <= 9007199254740991Omitted.
Currency code
Available options:
USD, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW Omitted.
The trial period in days. If the trial period is 0 or null, there will be no trial period.
Required range:
0 < x <= 9007199254740991Used as a flag to soft delete a subscription item without losing its history for auditability. If set, it will be removed from the subscription items list and will not be included in the billing period item list. Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Experimental fields. May change without notice.
Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Allowed value:
"toggle"Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991The type of aggregation to perform on the usage meter. Defaults to "sum", which aggregates all the usage event amounts for the billing period. "count_distinct_properties" counts the number of distinct properties in the billing period for a given meter.
Available options:
sum, count_distinct_properties Show child attributes
Show child attributes
An invoice record, which describes a bill that can be associated with a purchase, subscription, or stand alone. Each invoice has a specific type that determines its behavior and required fields.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Available options:
draft, open, paid, uncollectible, void, refunded, partially_refunded, awaiting_payment_confirmation Allowed value:
"purchase"Currency code
Available options:
USD, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW Required range:
-2147483648 <= x <= 2147483647Required range:
-2147483648 <= x <= 2147483647Required range:
-2147483648 <= x <= 2147483647Omitted.
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Omitted.
Omitted.
Omitted.
Available options:
amusement_tax, communications_tax, gst, hst, igst, jct, lease_tax, pst, qst, rst, sales_tax, vat, none ISO 3166-1 alpha-2 country code
Available options:
AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW - Option 1
- Option 2
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-2147483648 <= x <= 2147483647Required range:
-2147483648 <= x <= 2147483647Allowed value:
"static"Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
card, link, us_bank_account, sepa_debit A purchase record, which describes a transaction that can be associated with either a subscription or single payment price. Each purchase has a specific type that determines its behavior and required fields.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Available options:
open, pending, failed, paid, refunded, partial_refund, fraudulent A positive integer
Required range:
x <= 9007199254740991Allowed value:
"subscription"A positive integer
Required range:
0 < x <= 9007199254740991A positive integer
Required range:
x <= 9007199254740991Available options:
day, week, month, year A positive integer
Required range:
x <= 9007199254740991A positive integer
Required range:
0 < x <= 9007199254740991Omitted.
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Available options:
day, week, month, year A positive integer
Required range:
x <= 9007199254740991Allowed value:
"subscription"Whether or not this price is the default price for the product.
The price per unit. This should be in the smallest unit of the currency. For example, if the currency is USD, GBP, CAD, EUR or SGD, the price should be in cents.
Required range:
0 < x <= 9007199254740991Omitted.
Currency code
Available options:
USD, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW Omitted.
The trial period in days. If the trial period is 0 or null, there will be no trial period.
Required range:
0 < x <= 9007199254740991The default price for the product. If no price is explicitly set as default, will return the first price created for the product..
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Available options:
day, week, month, year A positive integer
Required range:
x <= 9007199254740991Allowed value:
"subscription"Whether or not this price is the default price for the product.
The price per unit. This should be in the smallest unit of the currency. For example, if the currency is USD, GBP, CAD, EUR or SGD, the price should be in cents.
Required range:
0 < x <= 9007199254740991Omitted.
Currency code
Available options:
USD, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW Omitted.
The trial period in days. If the trial period is 0 or null, there will be no trial period.
Required range:
0 < x <= 9007199254740991- Option 1
- Option 2
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Allowed value:
"toggle"Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991The type of aggregation to perform on the usage meter. Defaults to "sum", which aggregates all the usage event amounts for the billing period. "count_distinct_properties" counts the number of distinct properties in the billing period for a given meter.
Available options:
sum, count_distinct_properties The default product for the pricing model. If no product is explicitly set as default, will return undefined.
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Available options:
day, week, month, year A positive integer
Required range:
x <= 9007199254740991Allowed value:
"subscription"Whether or not this price is the default price for the product.
The price per unit. This should be in the smallest unit of the currency. For example, if the currency is USD, GBP, CAD, EUR or SGD, the price should be in cents.
Required range:
0 < x <= 9007199254740991Omitted.
Currency code
Available options:
USD, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW Omitted.
The trial period in days. If the trial period is 0 or null, there will be no trial period.
Required range:
0 < x <= 9007199254740991The default price for the product. If no price is explicitly set as default, will return the first price created for the product..
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Available options:
day, week, month, year A positive integer
Required range:
x <= 9007199254740991Allowed value:
"subscription"Whether or not this price is the default price for the product.
The price per unit. This should be in the smallest unit of the currency. For example, if the currency is USD, GBP, CAD, EUR or SGD, the price should be in cents.
Required range:
0 < x <= 9007199254740991Omitted.
Currency code
Available options:
USD, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW Omitted.
The trial period in days. If the trial period is 0 or null, there will be no trial period.
Required range:
0 < x <= 9007199254740991- Option 1
- Option 2
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Allowed value:
"toggle"Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Available options:
day, week, month, year A positive integer
Required range:
x <= 9007199254740991Allowed value:
"subscription"Whether or not this price is the default price for the product.
The price per unit. This should be in the smallest unit of the currency. For example, if the currency is USD, GBP, CAD, EUR or SGD, the price should be in cents.
Required range:
0 < x <= 9007199254740991Omitted.
Currency code
Available options:
USD, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW Omitted.
The trial period in days. If the trial period is 0 or null, there will be no trial period.
Required range:
0 < x <= 9007199254740991The default price for the product. If no price is explicitly set as default, will return the first price created for the product..
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Available options:
day, week, month, year A positive integer
Required range:
x <= 9007199254740991Allowed value:
"subscription"Whether or not this price is the default price for the product.
The price per unit. This should be in the smallest unit of the currency. For example, if the currency is USD, GBP, CAD, EUR or SGD, the price should be in cents.
Required range:
0 < x <= 9007199254740991Omitted.
Currency code
Available options:
USD, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW Omitted.
The trial period in days. If the trial period is 0 or null, there will be no trial period.
Required range:
0 < x <= 9007199254740991- Option 1
- Option 2
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Allowed value:
"toggle"Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991The type of aggregation to perform on the usage meter. Defaults to "sum", which aggregates all the usage event amounts for the billing period. "count_distinct_properties" counts the number of distinct properties in the billing period for a given meter.
Available options:
sum, count_distinct_properties The default product for the pricing model. If no product is explicitly set as default, will return undefined.
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Available options:
day, week, month, year A positive integer
Required range:
x <= 9007199254740991Allowed value:
"subscription"Whether or not this price is the default price for the product.
The price per unit. This should be in the smallest unit of the currency. For example, if the currency is USD, GBP, CAD, EUR or SGD, the price should be in cents.
Required range:
0 < x <= 9007199254740991Omitted.
Currency code
Available options:
USD, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW Omitted.
The trial period in days. If the trial period is 0 or null, there will be no trial period.
Required range:
0 < x <= 9007199254740991The default price for the product. If no price is explicitly set as default, will return the first price created for the product..
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Available options:
day, week, month, year A positive integer
Required range:
x <= 9007199254740991Allowed value:
"subscription"Whether or not this price is the default price for the product.
The price per unit. This should be in the smallest unit of the currency. For example, if the currency is USD, GBP, CAD, EUR or SGD, the price should be in cents.
Required range:
0 < x <= 9007199254740991Omitted.
Currency code
Available options:
USD, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW Omitted.
The trial period in days. If the trial period is 0 or null, there will be no trial period.
Required range:
0 < x <= 9007199254740991- Option 1
- Option 2
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Allowed value:
"toggle"The billing portal URL for the customer
The current subscriptions for the customer. By default, customers can only have one active subscription at a time. This will only return multiple subscriptions if you have enabled multiple subscriptions per customer.
- Option 1
- Option 2
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Available options:
active, canceled, credit_trial Omitted.
Omitted.
Omitted.
Omitted.
Omitted.
Omitted.
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991A positive integer
Required range:
0 < x <= 9007199254740991A positive integer
Required range:
x <= 9007199254740991Allowed value:
"static"- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Available options:
day, week, month, year A positive integer
Required range:
x <= 9007199254740991Allowed value:
"subscription"Whether or not this price is the default price for the product.
The price per unit. This should be in the smallest unit of the currency. For example, if the currency is USD, GBP, CAD, EUR or SGD, the price should be in cents.
Required range:
0 < x <= 9007199254740991Omitted.
Currency code
Available options:
USD, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW Omitted.
The trial period in days. If the trial period is 0 or null, there will be no trial period.
Required range:
0 < x <= 9007199254740991Used as a flag to soft delete a subscription item without losing its history for auditability. If set, it will be removed from the subscription items list and will not be included in the billing period item list. Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Experimental fields. May change without notice.
Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Allowed value:
"toggle"Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991The type of aggregation to perform on the usage meter. Defaults to "sum", which aggregates all the usage event amounts for the billing period. "count_distinct_properties" counts the number of distinct properties in the billing period for a given meter.
Available options:
sum, count_distinct_properties The most recently created current subscription for the customer. If createdAt timestamps tie, the most recently updated subscription will be returned. If updatedAt also ties, subscription id is used as the final tiebreaker.
- Option 1
- Option 2
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Available options:
active, canceled, credit_trial Omitted.
Omitted.
Omitted.
Omitted.
Omitted.
Omitted.
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991A positive integer
Required range:
0 < x <= 9007199254740991A positive integer
Required range:
x <= 9007199254740991Allowed value:
"static"- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Available options:
day, week, month, year A positive integer
Required range:
x <= 9007199254740991Allowed value:
"subscription"Whether or not this price is the default price for the product.
The price per unit. This should be in the smallest unit of the currency. For example, if the currency is USD, GBP, CAD, EUR or SGD, the price should be in cents.
Required range:
0 < x <= 9007199254740991Omitted.
Currency code
Available options:
USD, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW Omitted.
The trial period in days. If the trial period is 0 or null, there will be no trial period.
Required range:
0 < x <= 9007199254740991Used as a flag to soft delete a subscription item without losing its history for auditability. If set, it will be removed from the subscription items list and will not be included in the billing period item list. Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Experimental fields. May change without notice.
Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Allowed value:
"toggle"Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991The type of aggregation to perform on the usage meter. Defaults to "sum", which aggregates all the usage event amounts for the billing period. "count_distinct_properties" counts the number of distinct properties in the billing period for a given meter.
Available options:
sum, count_distinct_properties Was this page helpful?
⌘I