v1
latestOpenAPI 3.1.02026-07-241120379.1 KBRead all giftSubscriptions
get/2023-10/giftSubscription
Query parameters
pageNo.integer
pageSizeinteger
Max size - 100
updatedAtStartEpochinteger
Start date epoch for filter based on subscription updationAt date
updatedAtEndEpochinteger
End date epoch for filter based on subscription updationAt date
status'ACTIVE' | 'COMPLETED' | 'CANCELLED'
nextBillingStartEpochinteger
Start date epoch for filter based on subscription next billing date
nextBillingEndEpochinteger
End date epoch for filter based on subscription next billing date
lastInventoryAction'SKIPPED' | 'DELAYED' | 'PARTIAL_BILLED'
Response
200
Example response
{
"success": true,
"message": "Gift subscriptions fetched successfully",
"data": [
{
"id": 3516908,
"shopifyId": 32261341482,
"originOrderShopifyId": 6199430676778,
"createdAt": "2024-10-01T15:57:29.000Z",
"updatedAt": "2024-10-01T16:10:27.000Z",
"totalLineItemPrice": 21.67,
"totalLineItemDiscountedPrice": 21.67,
"currencyCode": "USD",
"status": "COMPLETED",
"completedOrdersCount": 3,
"attributes": [
{
"key": "_loopIsGiftSubscription",
"value": "true"
}
],
"lastPaymentStatus": "SUCCESS",
"deliveryMethod": {
"code": "Economy",
"title": "Economy"
},
"billingPolicy": {
"maxCycles": 3,
"interval": "MONTH",
"intervalCount": 3
},
"deliveryPolicy": {
"interval": "MONTH",
"intervalCount": 1
},
"shippingAddress": {
"firstName": "Test",
"lastName": "Mishra",
"address1": "212 Wall Street",
"city": "New York",
"zip": "10005",
"countryCode": "US",
"provinceCode": "NY"
},
"lines": [
{
"id": 12047576,
"productShopifyId": 9510292619562,
"variantShopifyId": 49350295617834,
"variantTitle": "Small",
"productTitle": "Coffee beans",
"name": "Coffee beans - Small",
"price": "21.67",
"basePrice": 100,
"discountedPrice": 21.67,
"quantity": 1
}
],
"customer": {
"id": 100783805,
"shopifyId": 8684269338922
},
"prepaidCredits": "0.00"
}
],
"code": "SUCCESS"
}