Get Customer Subscriptions
GET endpoint for /brand/subscriptions/get-customer-subscriptions in brand category
Overview
- Method: GET
- Path:
/brand/subscriptions/get-customer-subscriptions - Tags: brand
Parameters
No parameters required.
Request Body
No request body required.
Responses
200
Successful response
Content Type: application/json
{
"type": "object",
"properties": {
"subscriptions": {
"type": "string"
},
"state": {
"type": "string"
},
"productName": {
"type": "string"
},
"variantTitle": {
"type": "string"
},
"frequency": {
"type": "string"
},
"totalFulfillments": {
"type": "number"
},
"currentFulfillmentIndex": {
"type": "number"
},
"remainingRefills": {
"type": "number"
},
"nextShipmentDate": {
"type": "string"
},
"subscriptionEndDate": {
"type": "string"
},
"latestOrderId": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"stripeSubscriptionId": {
"type": "string"
},
"shippingAddress": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"address_1": {
"type": "string"
},
"address_2": {
"type": "string"
},
"city": {
"type": "string"
},
"country_code": {
"type": "string"
},
"province": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"phone": {
"type": "string"
}
},
"required": [
"subscriptions",
"state",
"productName",
"variantTitle",
"frequency",
"totalFulfillments",
"currentFulfillmentIndex",
"remainingRefills",
"createdAt",
"updatedAt",
"shippingAddress",
"first_name",
"last_name",
"address_1",
"city",
"country_code",
"postal_code"
]
}400
Bad Request
Content Type: application/json
{
"$ref": "#/components/schemas/Error"
}401
Unauthorized
404
Not Found
500
Internal Server Error
Example Usage
curl -X GET \
http://localhost:9000/brand/subscriptions/get-customer-subscriptions \
-H "Content-Type: application/json" \
Interactive Testing
You can test this endpoint interactively in the Swagger UI (opens in a new tab).