curl --request GET \
--url https://app.flowglad.com/api/v1/purchases/{id} \
--header 'Authorization: <api-key>'{
"purchase": {
"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": {}
}
}curl --request GET \
--url https://app.flowglad.com/api/v1/purchases/{id} \
--header 'Authorization: <api-key>'{
"purchase": {
"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": {}
}
}Successful response
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.
Show child attributes
Epoch milliseconds.
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
-9007199254740991 <= x <= 9007199254740991open, pending, failed, paid, refunded, partial_refund, fraudulent A positive integer
x <= 9007199254740991"subscription"A positive integer
0 < x <= 9007199254740991A positive integer
x <= 9007199254740991day, week, month, year A positive integer
x <= 9007199254740991A positive integer
0 < x <= 9007199254740991Omitted.
Epoch milliseconds.
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes
Was this page helpful?