Subrise Subscriptions Documentation for Shopify
Launch App
  • 🌎User Guides
    • πŸ‘‹Getting started with Subrise Subscriptions
    • 🎞️Dashboard Overview
      • πŸ“ŠReports
    • βš“Subscription Setup
      • πŸ‘ΎCreating your Subscription Plan
      • πŸ“™Managing your Subscription
    • πŸ› οΈSettings
      • Integrations
        • Attentive Integration
        • Shopify Flow
        • Klaviyo Integration
        • Zapier Integration
        • Mailchimp Integration
        • Google Sheets Integration
      • Notifications
      • Tags
      • Webhooks
      • Customer Portal
      • Support
    • ☸️Theme Extension
    • ❔FAQ
  • πŸ’»api-docs
    • πŸŒ„Getting Started
    • πŸ”‘Authentication
    • ♻️Subscriptions
      • 🟒GET
      • 🟠UPDATE
      • πŸ”΄DELETE
    • 🍘Products
    • πŸ“ƒSubscription Plans
    • ☺️Customers
    • πŸͺ΅Fields & Events
Powered by GitBook
On this page

Was this helpful?

  1. api-docs
  2. Subscriptions

GET

PreviousSubscriptionsNextUPDATE

Last updated 1 year ago

Was this helpful?

πŸ’»
♻️
🟒

Retrieve billing attempts

get

Fetches billing attempts, optionally filtered by shop and customer ID, with support for pagination.

Query parameters
shopstringRequired

The shop domain associated with the billing attempts.

customerIdstringOptional

The customer ID to filter billing attempts by.

pageintegerOptional

The page number for pagination.

Default: 1
limitintegerOptional

The number of items per page for pagination.

Default: 10
Responses
200
A list of billing attempts.
application/json
500
Server error, such as when the query fails due to backend issues.
get
GET /subscriptions/attempts HTTP/1.1
Host: localhost:3002
Accept: */*
{
  "data": [
    {
      "id": "text",
      "shop": "text",
      "completed_at": "2025-05-16T11:35:12.732Z",
      "created_at": "2025-05-16T11:35:12.732Z",
      "subscription_contract_id": "text",
      "customer_id": "text",
      "email": "text",
      "customer_name": "text",
      "customer_legacy_id": "text",
      "error_code": "text",
      "error_message": "text",
      "origin_time": "2025-05-16T11:35:12.732Z",
      "order_id": "text",
      "order_name": "text",
      "order_total": "text",
      "ready": true,
      "fulfillment_orders": [
        {
          "id": "text",
          "createdAt": "2025-05-16T11:35:12.732Z",
          "fulfillAt": "2025-05-16T11:35:12.732Z",
          "fulfillBy": "text",
          "status": "text",
          "updatedAt": "2025-05-16T11:35:12.732Z",
          "destination_city": "text",
          "destination_zip": "text"
        }
      ],
      "line_items": [
        {
          "discountedUnitPriceSet": "text",
          "discountedTotalSet": "text",
          "id": "text",
          "imageUrl": "text",
          "productId": "text",
          "productTitle": "text",
          "productVariantId": "text",
          "productVariantTitle": "text",
          "sellingPlanId": "text",
          "quantity": 1,
          "sku": "text"
        }
      ]
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 1,
  "pageCount": 1
}
  • POSTSearch subscription contracts
  • GETRetrieve a subscription contract
  • GETRetrieve billing attempts

Retrieve a subscription contract

get

Fetches a single subscription contract by its ID along with its billing attempts.

Path parameters
contractIdstringRequired

The subscription contract ID

Responses
200
A single subscription contract with billing attempts
application/json
400
Error response if the contract ID is invalid or not found
application/json
get
GET /subscription-contracts/{contractId} HTTP/1.1
Host: localhost:3002
Accept: */*
{
  "data": {
    "id": "text",
    "failedBillingCount": 1,
    "subscriptionTotal": 1,
    "draft": true,
    "createdAt": "text",
    "notification_at": "2025-05-16T11:35:12.732Z",
    "notified": true,
    "billingInterval": "text",
    "billingIntervalCount": 1,
    "maxCycles": 1,
    "isPrepaid": true,
    "minCycles": 1,
    "billingAnchorType": "text",
    "billingAnchorDay": 1,
    "billingAnchorMonth": 1,
    "currencyCode": "text",
    "customer": {
      "id": "text",
      "addresses": [
        {
          "id": "text",
          "address1": "text",
          "address2": "text",
          "city": "text",
          "company": "text",
          "country": "text",
          "countryCodeV2": "text",
          "firstName": "text",
          "lastName": "text",
          "phone": "text",
          "province": "text",
          "provinceCode": "text",
          "zip": "text"
        }
      ],
      "tags": [
        "text"
      ],
      "firstName": "text",
      "lastName": "text",
      "email": "text",
      "phone": "text",
      "state": "text",
      "createdAt": "text",
      "imageUrl": "text"
    },
    "deliveryPrice": 1,
    "customAttributes": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "orderIds": [
      "text"
    ],
    "status": "text",
    "shop": "text",
    "lines": [
      {
        "id": "text",
        "sku": "text",
        "title": "text",
        "productId": "text",
        "variantId": "text",
        "variantTitle": "text",
        "sellingPlanName": "text",
        "displayName": "text",
        "sellingPlanId": "text",
        "quantity": 1,
        "taxable": true,
        "handle": "text",
        "variantImage": {
          "url": "text"
        },
        "currentPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "lineDiscountedPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "requiresShipping": true,
        "customAttributes": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "discountAllocations": [
          {
            "amount": {
              "amount": "text",
              "currencyCode": "text"
            },
            "discount": "text"
          }
        ],
        "pricingPolicy": {
          "basePrice": {
            "amount": "text",
            "currencyCode": "text"
          },
          "cycleDiscounts": [
            {
              "adjustmentType": "text",
              "adjustmentValue": {
                "SellingPlanPricingPolicyPercentageValue": {
                  "percentage": "text"
                }
              },
              "afterCycle": 1,
              "computedPrice": {
                "amount": "text",
                "currencyCode": "text"
              }
            }
          ]
        }
      }
    ],
    "addons": [
      {
        "id": "text",
        "sku": "text",
        "title": "text",
        "productId": "text",
        "variantId": "text",
        "variantTitle": "text",
        "sellingPlanName": "text",
        "displayName": "text",
        "sellingPlanId": "text",
        "quantity": 1,
        "taxable": true,
        "handle": "text",
        "variantImage": {
          "url": "text"
        },
        "currentPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "lineDiscountedPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "requiresShipping": true,
        "customAttributes": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "discountAllocations": [
          {
            "amount": {
              "amount": "text",
              "currencyCode": "text"
            },
            "discount": "text"
          }
        ],
        "pricingPolicy": {
          "basePrice": {
            "amount": "text",
            "currencyCode": "text"
          },
          "cycleDiscounts": [
            {
              "adjustmentType": "text",
              "adjustmentValue": {
                "SellingPlanPricingPolicyPercentageValue": {
                  "percentage": "text"
                }
              },
              "afterCycle": 1,
              "computedPrice": {
                "amount": "text",
                "currencyCode": "text"
              }
            }
          ]
        }
      }
    ],
    "deliveryMethod": {
      "shippingOption": {
        "code": "text",
        "description": "text"
      }
    },
    "originOrder": {
      "id": "text",
      "legacyResourceId": "text",
      "name": "text",
      "createdAt": "text",
      "amount": "text"
    }
  },
  "billingAttempts": [
    {
      "id": "text",
      "subscription_contract_id": "text",
      "created_at": "2025-05-16T11:35:12.732Z",
      "status": "text",
      "errorMessage": "text"
    }
  ]
}

Search subscription contracts

post

Searches for subscription contracts with various filters, sorting, and pagination.

Query parameters
pageintegerOptionalDefault: 1
limitintegerOptionalDefault: 600
Body
Responses
200
A list of subscription contracts with pagination details.
application/json
400
Invalid request parameters.
application/json
post
POST /subscription-contracts/search HTTP/1.1
Host: localhost:3002
Content-Type: application/json
Accept: */*
Content-Length: 401

{
  "filters": {
    "id": "text",
    "customerId": "text",
    "status": "text",
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "nextBillingDate": "text",
    "nextBillingDateStart": "text",
    "nextBillingDateEnd": "text",
    "productId": "text",
    "maxCycles": "text",
    "failed": true,
    "createdAt": "text",
    "draft": true,
    "isPrepaid": true,
    "searchQuery": "text",
    "sort": {
      "field": "text",
      "direction": 1
    }
  },
  "searchOrder": {
    "field": "text",
    "direction": 1
  }
}
{
  "data": [
    {
      "id": "text",
      "failedBillingCount": 1,
      "subscriptionTotal": 1,
      "draft": true,
      "createdAt": "text",
      "notification_at": "2025-05-16T11:35:12.732Z",
      "notified": true,
      "billingInterval": "text",
      "billingIntervalCount": 1,
      "maxCycles": 1,
      "isPrepaid": true,
      "minCycles": 1,
      "billingAnchorType": "text",
      "billingAnchorDay": 1,
      "billingAnchorMonth": 1,
      "currencyCode": "text",
      "customer": {
        "id": "text",
        "addresses": [
          {
            "id": "text",
            "address1": "text",
            "address2": "text",
            "city": "text",
            "company": "text",
            "country": "text",
            "countryCodeV2": "text",
            "firstName": "text",
            "lastName": "text",
            "phone": "text",
            "province": "text",
            "provinceCode": "text",
            "zip": "text"
          }
        ],
        "tags": [
          "text"
        ],
        "firstName": "text",
        "lastName": "text",
        "email": "text",
        "phone": "text",
        "state": "text",
        "createdAt": "text",
        "imageUrl": "text"
      },
      "deliveryPrice": 1,
      "customAttributes": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "orderIds": [
        "text"
      ],
      "status": "text",
      "shop": "text",
      "lines": [
        {
          "id": "text",
          "sku": "text",
          "title": "text",
          "productId": "text",
          "variantId": "text",
          "variantTitle": "text",
          "sellingPlanName": "text",
          "displayName": "text",
          "sellingPlanId": "text",
          "quantity": 1,
          "taxable": true,
          "handle": "text",
          "variantImage": {
            "url": "text"
          },
          "currentPrice": {
            "amount": "text",
            "currencyCode": "text"
          },
          "lineDiscountedPrice": {
            "amount": "text",
            "currencyCode": "text"
          },
          "requiresShipping": true,
          "customAttributes": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "discountAllocations": [
            {
              "amount": {
                "amount": "text",
                "currencyCode": "text"
              },
              "discount": "text"
            }
          ],
          "pricingPolicy": {
            "basePrice": {
              "amount": "text",
              "currencyCode": "text"
            },
            "cycleDiscounts": [
              {
                "adjustmentType": "text",
                "adjustmentValue": {
                  "SellingPlanPricingPolicyPercentageValue": {
                    "percentage": "text"
                  }
                },
                "afterCycle": 1,
                "computedPrice": {
                  "amount": "text",
                  "currencyCode": "text"
                }
              }
            ]
          }
        }
      ],
      "addons": [
        {
          "id": "text",
          "sku": "text",
          "title": "text",
          "productId": "text",
          "variantId": "text",
          "variantTitle": "text",
          "sellingPlanName": "text",
          "displayName": "text",
          "sellingPlanId": "text",
          "quantity": 1,
          "taxable": true,
          "handle": "text",
          "variantImage": {
            "url": "text"
          },
          "currentPrice": {
            "amount": "text",
            "currencyCode": "text"
          },
          "lineDiscountedPrice": {
            "amount": "text",
            "currencyCode": "text"
          },
          "requiresShipping": true,
          "customAttributes": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "discountAllocations": [
            {
              "amount": {
                "amount": "text",
                "currencyCode": "text"
              },
              "discount": "text"
            }
          ],
          "pricingPolicy": {
            "basePrice": {
              "amount": "text",
              "currencyCode": "text"
            },
            "cycleDiscounts": [
              {
                "adjustmentType": "text",
                "adjustmentValue": {
                  "SellingPlanPricingPolicyPercentageValue": {
                    "percentage": "text"
                  }
                },
                "afterCycle": 1,
                "computedPrice": {
                  "amount": "text",
                  "currencyCode": "text"
                }
              }
            ]
          }
        }
      ],
      "deliveryMethod": {
        "shippingOption": {
          "code": "text",
          "description": "text"
        }
      },
      "originOrder": {
        "id": "text",
        "legacyResourceId": "text",
        "name": "text",
        "createdAt": "text",
        "amount": "text"
      }
    }
  ],
  "totalCount": 1,
  "pageCount": 1
}