Skip to content
External APIs
/
/
Create a new shipping/del...

External APIs (0.0.1)

Comprehensive API documentation for managing subscriptions, payments, and related operations. These APIs allow you to programmatically manage subscription lifecycles, handle payments, configure products, and integrate subscription functionality into your applications.

Download OpenAPI description
external-api-swagger.json
external-api-swagger.yaml
Languages
Servers
https://subscription-admin.appstle.com

Subscription Management

Core APIs for managing the complete subscription lifecycle including creation, updates, pausing, resuming, and cancellation of subscriptions.

Operations

Subscription Payments

APIs for managing subscription payment methods, processing payments, handling payment retries, and updating billing information.

Operations

Subscription Contracts

APIs for managing subscription contracts including delivery schedules, pricing, order notes, billing cycles, and shipping addresses.

Operations

Subscription Products

APIs for managing products within subscriptions including adding, removing, updating quantities, and swapping products.

Operations

Billing & Payments

APIs for handling billing operations, payment processing, and financial transactions related to subscriptions.

Operations

Subscription Discounts

APIs for managing discounts and promotional codes applied to subscriptions.

Operations

Subscription One-Time Products

APIs for managing one-time add-on products that can be purchased alongside recurring subscription items.

Operations

Subscription Plans

APIs for managing subscription plans, pricing tiers, and plan configurations.

Operations

Build-a-Box & Bundles

APIs for managing customizable product boxes and bundles where customers can select multiple items.

Operations

Product Catalog

APIs for managing the product catalog including product information, variants, and inventory.

Operations

Operations & Settings

APIs for managing operational settings, configurations, and administrative functions.

Operations

Create a new shipping/delivery profile (V3)

Request

Creates a new shipping or delivery profile for subscription orders using the V3 request format. This is the latest version with the most comprehensive delivery profile configuration capabilities.

Enhancements in V3:

  • Full support for all Shopify delivery profile features
  • Advanced rate calculation options
  • Support for weight-based and price-based rates
  • Enhanced zone and country management
  • Better handling of delivery conditions and rules

Key Features:

  • Define complex shipping rate structures
  • Configure multiple delivery methods per zone
  • Set up conditional rates based on weight, price, or item count
  • Manage detailed shipping zones with province-level granularity
  • Full control over delivery profile settings

Authentication: Requires valid X-API-Key header

Query
api_keystring

API Key (Deprecated - Use Header X-API-Key instead)

Headers
X-API-Keystring
Bodyapplication/jsonrequired
namestring
sellingPlanGroupsArray of objects(SellingPlanGroupInfo)
locationsArray of objects(LocationInfoV3)
zonesArray of objects(ZoneInfo)
idstring
profileIdinteger(int64)
locationInfosArray of objects(LocationInfoV3)
curl -i -X POST \
  'https://subscription-admin.appstle.com/api/external/v2/delivery-profiles/v3/create-shipping-profile?api_key=string' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: string' \
  -d '{
    "name": "string",
    "sellingPlanGroups": [
      {
        "label": "string",
        "value": "string"
      }
    ],
    "locations": [
      {
        "label": "string",
        "value": "string"
      }
    ],
    "zones": [
      {
        "countries": [
          {
            "value": "string",
            "label": "string",
            "includeAllProvinces": true,
            "provinces": [
              {
                "label": "string",
                "value": "string"
              }
            ]
          }
        ],
        "restOfWorld": true,
        "deliveryMethods": [
          {
            "name": "string",
            "amount": 0.1,
            "deliveryConditionType": "string",
            "currencyCode": "USD",
            "minValue": 0.1,
            "maxValue": 0.1,
            "weightUnit": "string",
            "definitionType": "string",
            "carrierServiceId": "string",
            "carrierPercentageFee": 0.1,
            "carrierFixedFee": 0.1
          }
        ]
      }
    ],
    "id": "string",
    "profileId": 0,
    "locationInfos": [
      {
        "label": "string",
        "value": "string"
      }
    ]
  }'

Responses

Delivery profile created successfully

Bodyapplication/json
namestring
sellingPlanGroupsArray of objects(SellingPlanGroupInfo)
locationsArray of objects(LocationInfoV3)
zonesArray of objects(ZoneInfo)
idstring
profileIdinteger(int64)
locationInfosArray of objects(LocationInfoV3)
Response
application/json
{
  "name": "string",
  "sellingPlanGroups": [
    { … }
  ],
  "locations": [
    { … }
  ],
  "zones": [
    { … }
  ],
  "id": "string",
  "profileId": 0,
  "locationInfos": [
    { … }
  ]
}

Create a new shipping/delivery profile (V2)

Request

Creates a new shipping or delivery profile for subscription orders using the V2 request format. This version provides enhanced configuration options for delivery methods, zones, and pricing.

Enhancements in V2:

  • Improved zone configuration
  • Better support for multiple delivery methods
  • Enhanced rate definition capabilities
  • Support for conditional delivery rates

Key Features:

  • Define custom shipping rates per zone
  • Configure local delivery options
  • Set up local pickup methods
  • Manage shipping zones and countries
  • Assign profiles to specific products or variants

Authentication: Requires valid X-API-Key header

Query
api_keystring

API Key (Deprecated - Use Header X-API-Key instead)

Headers
X-API-Keystring
Bodyapplication/jsonrequired
namestring
locationInfosArray of objects(LocationInfo)
idstring
curl -i -X POST \
  'https://subscription-admin.appstle.com/api/external/v2/delivery-profiles/v2/create-shipping-profile?api_key=string' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: string' \
  -d '{
    "name": "string",
    "locationInfos": [
      {
        "locationId": "string",
        "countryInfos": [
          {
            "shouldIncludeAllProvince": true,
            "code": "string",
            "deliveryMethodInfo": [
              {
                "amount": 0.1,
                "currencyCode": "USD",
                "carrierServiceId": "string",
                "name": "string",
                "carrierRate": true,
                "deliveryConditionType": "string",
                "priceConditions": [
                  null
                ],
                "weightConditions": [
                  null
                ]
              }
            ],
            "restOfWorld": true,
            "provinceCode": "string"
          }
        ]
      }
    ],
    "id": "string"
  }'

Responses

Delivery profile created successfully

Bodyapplication/json
idinteger(int64)
shopstringrequired
deliveryProfileIdstringrequired
sellerGroupIdsArray of stringsunique
namestring
Response
application/json
{
  "id": 0,
  "shop": "string",
  "deliveryProfileId": "string",
  "sellerGroupIds": [
    "string"
  ],
  "name": "string"
}

Create a new shipping/delivery profile

Request

Creates a new shipping or delivery profile for subscription orders. This endpoint allows you to configure custom shipping rates, delivery methods, and shipping zones for your subscription products. Delivery profiles control how subscription products are shipped to customers.

Key Features:

  • Define custom shipping rates per zone
  • Configure local delivery options
  • Set up local pickup methods
  • Manage shipping zones and countries
  • Assign profiles to specific products or variants

Delivery Method Types:

  • SHIPPING: Standard shipping with carrier rates or custom rates
  • LOCAL_DELIVERY: Local delivery service within specific areas
  • PICKUP: Customer pickup from store locations

Important Notes:

  • Each delivery profile must have a unique name
  • At least one delivery method is required
  • Shipping rates can be set per zone and per weight/price range
  • Profiles can be assigned to subscription products to control their shipping behavior

Authentication: Requires valid X-API-Key header

Query
api_keystring

API Key (Deprecated - Use Header X-API-Key instead)

Headers
X-API-Keystring
Bodyapplication/jsonrequired
namestring
idinteger(int64)
deliveryMethodInfoArray of objects(DeliveryMethodInfo)
countryInfosArray of objects(DeliveryCountryInfo)
locationInfosArray of objects(LocationInfo)
restOfWorldboolean
curl -i -X POST \
  'https://subscription-admin.appstle.com/api/external/v2/delivery-profiles/create-shipping-profile?api_key=string' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: string' \
  -d '{
    "name": "string",
    "id": 0,
    "deliveryMethodInfo": [
      {
        "amount": 0.1,
        "currencyCode": "USD",
        "carrierServiceId": "string",
        "name": "string",
        "carrierRate": true,
        "deliveryConditionType": "string",
        "priceConditions": [
          {
            "amount": 0.1,
            "deliverCondtion": "string"
          }
        ],
        "weightConditions": [
          {
            "deliveryCondition": "string",
            "weight": 0.1,
            "weightUnit": "string"
          }
        ]
      }
    ],
    "countryInfos": [
      {
        "code": "string",
        "restOfWorld": true,
        "provinceCode": "string",
        "shouldIncludeAllProvince": true
      }
    ],
    "locationInfos": [
      {
        "locationId": "string",
        "countryInfos": [
          {
            "shouldIncludeAllProvince": true,
            "code": "string",
            "deliveryMethodInfo": [
              {
                "amount": 0.1,
                "currencyCode": "USD",
                "carrierServiceId": "string",
                "name": "string",
                "carrierRate": true,
                "deliveryConditionType": "string",
                "priceConditions": [
                  null
                ],
                "weightConditions": [
                  null
                ]
              }
            ],
            "restOfWorld": true,
            "provinceCode": "string"
          }
        ]
      }
    ],
    "restOfWorld": true
  }'

Responses

Delivery profile created successfully

Bodyapplication/json
idinteger(int64)
shopstringrequired
deliveryProfileIdstringrequired
sellerGroupIdsArray of stringsunique
namestring
Response
application/json
{
  "id": "12345",
  "shop": "example-shop.myshopify.com",
  "name": "Standard Subscription Shipping",
  "shopifyDeliveryProfileId": "gid://shopify/DeliveryProfile/67890",
  "default": false,
  "locationGroupsCount": 1,
  "productsCount": 15,
  "profileLocationGroups": [
    { … }
  ]
}

Customer Portal

APIs powering the customer-facing portal where subscribers can manage their own subscriptions.

Operations

Customers

APIs for managing customer information, profiles, and account details.

Operations