Customer
Get Billing Details
GET
/
api
/
v1
/
customers
/
{externalId}
/
billing
curl --request GET \
--url https://app.flowglad.com/api/v1/customers/{externalId}/billing \
--header 'Authorization: <api-key>'
{
"customer": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"organizationId": "<string>",
"email": "<string>",
"name": "<string>",
"invoiceNumberBase": "<string>",
"archived": true,
"logoURL": "<string>",
"iconURL": "<string>",
"domain": "<string>",
"billingAddress": {
"name": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"address": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"phone": "<string>"
},
"externalId": "<string>",
"userId": "<string>",
"catalogId": "<string>"
},
"subscriptions": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"startDate": "2023-11-07T05:31:56Z",
"customerId": "<string>",
"organizationId": "<string>",
"status": "trialing",
"defaultPaymentMethodId": "<string>",
"backupPaymentMethodId": "<string>",
"trialEnd": "2023-11-07T05:31:56Z",
"currentBillingPeriodStart": "2023-11-07T05:31:56Z",
"currentBillingPeriodEnd": "2023-11-07T05:31:56Z",
"metadata": {},
"canceledAt": "2023-11-07T05:31:56Z",
"cancelScheduledAt": "2023-11-07T05:31:56Z",
"priceId": "<string>",
"runBillingAtPeriodStart": true,
"interval": "day",
"intervalCount": 123,
"billingCycleAnchorDate": "2023-11-07T05:31:56Z",
"name": "<string>",
"current": true,
"subscriptionItems": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"subscriptionId": "<string>",
"name": "<string>",
"addedDate": "2023-11-07T05:31:56Z",
"priceId": "<string>",
"unitPrice": 123,
"quantity": 123,
"metadata": {},
"externalId": "<string>",
"price": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "subscription",
"trialPeriodDays": 123,
"setupFeeAmount": 123,
"isDefault": true,
"unitPrice": 123,
"productId": "<string>",
"active": true,
"currency": "USD",
"usageMeterId": "<string>"
}
}
]
}
],
"invoices": [
{
"invoice": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"purchaseId": "<string>",
"invoiceNumber": "<string>",
"invoiceDate": "2023-11-07T05:31:56Z",
"billingPeriodId": "null",
"dueDate": "2023-11-07T05:31:56Z",
"customerId": "<string>",
"organizationId": "<string>",
"status": "draft",
"subscriptionId": "null",
"billingPeriodStartDate": "2023-11-07T05:31:56Z",
"billingPeriodEndDate": "2023-11-07T05:31:56Z",
"ownerMembershipId": "<string>",
"pdfURL": "<string>",
"receiptPdfURL": "<string>",
"memo": "<string>",
"bankPaymentOnly": true,
"type": "purchase",
"currency": "USD",
"taxAmount": 123,
"subtotal": 123,
"taxType": "amusement_tax",
"taxCountry": "AF",
"taxState": "<string>",
"taxRatePercentage": "<string>",
"applicationFee": 123
},
"invoiceLineItems": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"invoiceId": "<string>",
"quantity": 123,
"priceId": "<string>",
"description": "<string>",
"price": 123
}
]
}
],
"paymentMethods": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"customerId": "<string>",
"billingDetails": {
"name": "<string>",
"email": "<string>",
"address": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"address": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
}
}
},
"type": "card",
"default": true,
"paymentMethodData": {},
"metadata": {}
}
],
"purchases": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"name": "<string>",
"status": "open",
"customerId": "<string>",
"organizationId": "<string>",
"billingCycleAnchor": "2023-11-07T05:31:56Z",
"priceId": "<string>",
"quantity": 123,
"priceType": "subscription",
"trialPeriodDays": 123,
"pricePerBillingCycle": 123,
"intervalUnit": "day",
"intervalCount": 123,
"firstInvoiceValue": 123,
"totalPurchaseValue": "<any>",
"bankPaymentOnly": true,
"purchaseDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"proposal": "<string>",
"archived": true,
"billingAddress": "<string>",
"metadata": {}
}
],
"currentSubscriptions": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"startDate": "2023-11-07T05:31:56Z",
"customerId": "<string>",
"organizationId": "<string>",
"status": "trialing",
"defaultPaymentMethodId": "<string>",
"backupPaymentMethodId": "<string>",
"trialEnd": "2023-11-07T05:31:56Z",
"currentBillingPeriodStart": "2023-11-07T05:31:56Z",
"currentBillingPeriodEnd": "2023-11-07T05:31:56Z",
"metadata": {},
"canceledAt": "2023-11-07T05:31:56Z",
"cancelScheduledAt": "2023-11-07T05:31:56Z",
"priceId": "<string>",
"runBillingAtPeriodStart": true,
"interval": "day",
"intervalCount": 123,
"billingCycleAnchorDate": "2023-11-07T05:31:56Z",
"name": "<string>",
"current": true,
"subscriptionItems": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"subscriptionId": "<string>",
"name": "<string>",
"addedDate": "2023-11-07T05:31:56Z",
"priceId": "<string>",
"unitPrice": 123,
"quantity": 123,
"metadata": {},
"externalId": "<string>",
"price": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "subscription",
"trialPeriodDays": 123,
"setupFeeAmount": 123,
"isDefault": true,
"unitPrice": 123,
"productId": "<string>",
"active": true,
"currency": "USD",
"usageMeterId": "<string>"
}
}
]
}
],
"catalog": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"organizationId": "<string>",
"isDefault": true,
"name": "<string>",
"products": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"name": "<string>",
"description": "<string>",
"imageURL": "<string>",
"organizationId": "<string>",
"displayFeatures": [
{
"enabled": true,
"label": "<string>",
"details": "<string>"
}
],
"active": true,
"singularQuantityLabel": "<string>",
"pluralQuantityLabel": "<string>",
"catalogId": "<string>",
"prices": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "subscription",
"trialPeriodDays": 123,
"setupFeeAmount": 123,
"isDefault": true,
"unitPrice": 123,
"productId": "<string>",
"active": true,
"currency": "USD",
"usageMeterId": "<string>"
}
],
"defaultPrice": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "subscription",
"trialPeriodDays": 123,
"setupFeeAmount": 123,
"isDefault": true,
"unitPrice": 123,
"productId": "<string>",
"active": true,
"currency": "USD",
"usageMeterId": "<string>"
}
}
],
"usageMeters": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"organizationId": "<string>",
"name": "<string>",
"catalogId": "<string>",
"aggregationType": "sum"
}
]
}
}
Authorizations
Path Parameters
The ID of the customer, as defined in your application
Response
200
application/json
Successful response
The response is of type object
.
curl --request GET \
--url https://app.flowglad.com/api/v1/customers/{externalId}/billing \
--header 'Authorization: <api-key>'
{
"customer": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"organizationId": "<string>",
"email": "<string>",
"name": "<string>",
"invoiceNumberBase": "<string>",
"archived": true,
"logoURL": "<string>",
"iconURL": "<string>",
"domain": "<string>",
"billingAddress": {
"name": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"address": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"phone": "<string>"
},
"externalId": "<string>",
"userId": "<string>",
"catalogId": "<string>"
},
"subscriptions": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"startDate": "2023-11-07T05:31:56Z",
"customerId": "<string>",
"organizationId": "<string>",
"status": "trialing",
"defaultPaymentMethodId": "<string>",
"backupPaymentMethodId": "<string>",
"trialEnd": "2023-11-07T05:31:56Z",
"currentBillingPeriodStart": "2023-11-07T05:31:56Z",
"currentBillingPeriodEnd": "2023-11-07T05:31:56Z",
"metadata": {},
"canceledAt": "2023-11-07T05:31:56Z",
"cancelScheduledAt": "2023-11-07T05:31:56Z",
"priceId": "<string>",
"runBillingAtPeriodStart": true,
"interval": "day",
"intervalCount": 123,
"billingCycleAnchorDate": "2023-11-07T05:31:56Z",
"name": "<string>",
"current": true,
"subscriptionItems": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"subscriptionId": "<string>",
"name": "<string>",
"addedDate": "2023-11-07T05:31:56Z",
"priceId": "<string>",
"unitPrice": 123,
"quantity": 123,
"metadata": {},
"externalId": "<string>",
"price": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "subscription",
"trialPeriodDays": 123,
"setupFeeAmount": 123,
"isDefault": true,
"unitPrice": 123,
"productId": "<string>",
"active": true,
"currency": "USD",
"usageMeterId": "<string>"
}
}
]
}
],
"invoices": [
{
"invoice": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"purchaseId": "<string>",
"invoiceNumber": "<string>",
"invoiceDate": "2023-11-07T05:31:56Z",
"billingPeriodId": "null",
"dueDate": "2023-11-07T05:31:56Z",
"customerId": "<string>",
"organizationId": "<string>",
"status": "draft",
"subscriptionId": "null",
"billingPeriodStartDate": "2023-11-07T05:31:56Z",
"billingPeriodEndDate": "2023-11-07T05:31:56Z",
"ownerMembershipId": "<string>",
"pdfURL": "<string>",
"receiptPdfURL": "<string>",
"memo": "<string>",
"bankPaymentOnly": true,
"type": "purchase",
"currency": "USD",
"taxAmount": 123,
"subtotal": 123,
"taxType": "amusement_tax",
"taxCountry": "AF",
"taxState": "<string>",
"taxRatePercentage": "<string>",
"applicationFee": 123
},
"invoiceLineItems": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"invoiceId": "<string>",
"quantity": 123,
"priceId": "<string>",
"description": "<string>",
"price": 123
}
]
}
],
"paymentMethods": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"customerId": "<string>",
"billingDetails": {
"name": "<string>",
"email": "<string>",
"address": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"address": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
}
}
},
"type": "card",
"default": true,
"paymentMethodData": {},
"metadata": {}
}
],
"purchases": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"name": "<string>",
"status": "open",
"customerId": "<string>",
"organizationId": "<string>",
"billingCycleAnchor": "2023-11-07T05:31:56Z",
"priceId": "<string>",
"quantity": 123,
"priceType": "subscription",
"trialPeriodDays": 123,
"pricePerBillingCycle": 123,
"intervalUnit": "day",
"intervalCount": 123,
"firstInvoiceValue": 123,
"totalPurchaseValue": "<any>",
"bankPaymentOnly": true,
"purchaseDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"proposal": "<string>",
"archived": true,
"billingAddress": "<string>",
"metadata": {}
}
],
"currentSubscriptions": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"startDate": "2023-11-07T05:31:56Z",
"customerId": "<string>",
"organizationId": "<string>",
"status": "trialing",
"defaultPaymentMethodId": "<string>",
"backupPaymentMethodId": "<string>",
"trialEnd": "2023-11-07T05:31:56Z",
"currentBillingPeriodStart": "2023-11-07T05:31:56Z",
"currentBillingPeriodEnd": "2023-11-07T05:31:56Z",
"metadata": {},
"canceledAt": "2023-11-07T05:31:56Z",
"cancelScheduledAt": "2023-11-07T05:31:56Z",
"priceId": "<string>",
"runBillingAtPeriodStart": true,
"interval": "day",
"intervalCount": 123,
"billingCycleAnchorDate": "2023-11-07T05:31:56Z",
"name": "<string>",
"current": true,
"subscriptionItems": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"subscriptionId": "<string>",
"name": "<string>",
"addedDate": "2023-11-07T05:31:56Z",
"priceId": "<string>",
"unitPrice": 123,
"quantity": 123,
"metadata": {},
"externalId": "<string>",
"price": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "subscription",
"trialPeriodDays": 123,
"setupFeeAmount": 123,
"isDefault": true,
"unitPrice": 123,
"productId": "<string>",
"active": true,
"currency": "USD",
"usageMeterId": "<string>"
}
}
]
}
],
"catalog": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"organizationId": "<string>",
"isDefault": true,
"name": "<string>",
"products": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"name": "<string>",
"description": "<string>",
"imageURL": "<string>",
"organizationId": "<string>",
"displayFeatures": [
{
"enabled": true,
"label": "<string>",
"details": "<string>"
}
],
"active": true,
"singularQuantityLabel": "<string>",
"pluralQuantityLabel": "<string>",
"catalogId": "<string>",
"prices": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "subscription",
"trialPeriodDays": 123,
"setupFeeAmount": 123,
"isDefault": true,
"unitPrice": 123,
"productId": "<string>",
"active": true,
"currency": "USD",
"usageMeterId": "<string>"
}
],
"defaultPrice": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"intervalUnit": "day",
"name": "<string>",
"intervalCount": 123,
"type": "subscription",
"trialPeriodDays": 123,
"setupFeeAmount": 123,
"isDefault": true,
"unitPrice": 123,
"productId": "<string>",
"active": true,
"currency": "USD",
"usageMeterId": "<string>"
}
}
],
"usageMeters": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"organizationId": "<string>",
"name": "<string>",
"catalogId": "<string>",
"aggregationType": "sum"
}
]
}
}
Assistant
Responses are generated using AI and may contain mistakes.