Update subscription - Developer documentation

cURL

curl --request PATCH \
  --url https://api.juo.io/admin/v1/subscriptions/{subscriptionId} \
  --header 'Content-Type: application/json' \
  --header 'X-Juo-Admin-Api-Key: <api-key>' \
  --header 'X-Tenant-ID: <x-tenant-id>' \
  --data '
{
  "deliveryPrice": 1,
  "paymentMethod": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deliveryAddress": {
    "firstName": "<unknown>",
    "lastName": "<unknown>",
    "address1": "<unknown>",
    "address2": "<unknown>",
    "zip": "<unknown>",
    "city": "<unknown>",
    "country": "<unknown>",
    "countryCode": "<unknown>",
    "provinceCode": "<unknown>",
    "province": "<unknown>",
    "phone": "<unknown>",
    "company": "<unknown>"
  },
  "deliveryMethod": {
    "type": "shipping",
    "title": "<string>",
    "description": "<string>"
  },
  "nextBillingDate": "2023-11-07T05:31:56Z"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource": "subscription",
  "serial": "<string>",
  "status": "active",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "canceledAt": "<unknown>",
  "customer": "<string>",
  "nextBillingDate": "<unknown>",
  "currentCycle": 1,
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resource": "subscription-item",
      "title": "<string>",
      "subtitle": "<unknown>",
      "quantity": 2,
      "totalPrice": 1,
      "variant": "<string>",
      "recurringCycleLimit": "<unknown>",
      "canceledAt": "<unknown>"
    }
  ],
  "discounts": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resource": "subscription-discount",
      "title": "<unknown>",
      "target": {
        "type": "shipping"
      },
      "value": {
        "amount": 123,
        "type": "fixed-amount",
        "appliesOnEachItem": true
      },
      "recurringCycleLimit": "<unknown>"
    }
  ],
  "paymentMethod": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currencyCode": "<string>",
  "deliveryAddress": "<unknown>",
  "deliveryMethod": "<unknown>",
  "deliveryPrice": 1
}

PATCH

subscriptions

{subscriptionId}

cURL

curl --request PATCH \
  --url https://api.juo.io/admin/v1/subscriptions/{subscriptionId} \
  --header 'Content-Type: application/json' \
  --header 'X-Juo-Admin-Api-Key: <api-key>' \
  --header 'X-Tenant-ID: <x-tenant-id>' \
  --data '
{
  "deliveryPrice": 1,
  "paymentMethod": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deliveryAddress": {
    "firstName": "<unknown>",
    "lastName": "<unknown>",
    "address1": "<unknown>",
    "address2": "<unknown>",
    "zip": "<unknown>",
    "city": "<unknown>",
    "country": "<unknown>",
    "countryCode": "<unknown>",
    "provinceCode": "<unknown>",
    "province": "<unknown>",
    "phone": "<unknown>",
    "company": "<unknown>"
  },
  "deliveryMethod": {
    "type": "shipping",
    "title": "<string>",
    "description": "<string>"
  },
  "nextBillingDate": "2023-11-07T05:31:56Z"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource": "subscription",
  "serial": "<string>",
  "status": "active",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "canceledAt": "<unknown>",
  "customer": "<string>",
  "nextBillingDate": "<unknown>",
  "currentCycle": 1,
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resource": "subscription-item",
      "title": "<string>",
      "subtitle": "<unknown>",
      "quantity": 2,
      "totalPrice": 1,
      "variant": "<string>",
      "recurringCycleLimit": "<unknown>",
      "canceledAt": "<unknown>"
    }
  ],
  "discounts": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resource": "subscription-discount",
      "title": "<unknown>",
      "target": {
        "type": "shipping"
      },
      "value": {
        "amount": 123,
        "type": "fixed-amount",
        "appliesOnEachItem": true
      },
      "recurringCycleLimit": "<unknown>"
    }
  ],
  "paymentMethod": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currencyCode": "<string>",
  "deliveryAddress": "<unknown>",
  "deliveryMethod": "<unknown>",
  "deliveryPrice": 1
}

Authorizations

X-Juo-Admin-Api-Key

string

header

required

Headers

X-Tenant-ID

string

required

Unique identifier of the tenant in the system (usually a store identifier)

Path Parameters

subscriptionId

string<uuid>

required

The subscription identifier

Body

application/json

deliveryPrice

number

The delivery price for the upcoming renewal.

Required range: x >= 0

paymentMethod

string<uuid>

deliveryAddress

object

Show child attributes

deliveryAddress.firstName

null | string

Customer's first name.

Minimum string length: 1

deliveryAddress.lastName

null | string

Customer's last name.

Minimum string length: 1

deliveryAddress.address1

null | string

Primary street address.

Minimum string length: 1

deliveryAddress.address2

null | string

Additional address information (apartment, suite, etc.)

Minimum string length: 1

deliveryAddress.zip

null | string

Postal/ZIP code.

Minimum string length: 1

deliveryAddress.city

null | string

City name.

Minimum string length: 1

deliveryAddress.country

null | string

Full country name.

Minimum string length: 1

deliveryAddress.countryCode

null | string

Two-letter country code (ISO 3166-1).

Required string length: 2

deliveryAddress.provinceCode

null | string

Province/state code.

Minimum string length: 1

deliveryAddress.province

null | string

Full province/state name.

Minimum string length: 1

deliveryAddress.phone

null | string

Contact phone number.

Minimum string length: 1

deliveryAddress.company

null | string

Company name.

Minimum string length: 1

deliveryMethod

object

Show child attributes

deliveryMethod.type

enum<string>

Available options:

shipping

deliveryMethod.title

string

deliveryMethod.description

string

nextBillingDate

Response

200 - application/json

Default Response

string<uuid>

required

resource

enum<string>

required

Available options:

subscription

serial

string

required

Unique serial number that increments sequentially with each new subscription within a store.

Minimum string length: 1

status

enum<string>

required

Available options:

active,

paused,

canceled,

failed,

expired,

merged

createdAt

string<date-time>

required

Purchase date of the subscription.

updatedAt

string<date-time>

required

Last update date of the subscription.

canceledAt

null | string<date-time>

required

Cancellation date of the subscription.

customer

required

This field is expandable.

Minimum string length: 1

nextBillingDate

null | string<date-time>

required

The next billing date determines when the renewal process begins its billing phase. When billing succeeds, it creates one order—or multiple orders for prepaid subscriptions.

currentCycle

integer

required

The subscription's billing cycle count. It starts at 0 (before the first billing is completed), changes to 1 (after one billing is completed), and increases by 1 with each subsequent billing.

Required range: x >= 0

items

SubscriptionItem · object[]

required

Minimum array length: 1

Show child attributes

items.id

string<uuid>

required

items.resource

enum<string>

required

Available options:

subscription-item

items.title

string

required

Minimum string length: 1

items.subtitle

null | string

required

Matches the variant title in most cases

Minimum string length: 1

items.quantity

integer

required

Required range: x >= 1

items.totalPrice

number

required

Final item price including all discounts and taxes

Required range: x >= 0

items.variant

required

This field is expandable.

Minimum string length: 1

items.recurringCycleLimit

null | integer

required

The number of billing cycles for which this item will be applied. After the recurring cycle limit is met the item will be removed from the subscription.

Required range: x >= 1

items.canceledAt

null | string<date-time>

required

Cancellation date of the item.

discounts

SubscriptionDiscount · object[]

required

Show child attributes

discounts.id

string<uuid>

required

discounts.resource

enum<string>

required

Available options:

subscription-discount

discounts.title

null | string

required

The title of the discount shown to customers, typically displayed as a discount code.

Minimum string length: 1

discounts.target

object

required

Option 1
Option 2

Show child attributes

discounts.target.type

enum<string>

required

Available options:

shipping

discounts.value

object

required

Option 1
Option 2

Show child attributes

discounts.value.amount

number

required

discounts.value.type

enum<string>

required

Available options:

fixed-amount

discounts.value.appliesOnEachItem

boolean

required

When true, the amount will be proportionally split among all the items.

discounts.recurringCycleLimit

null | integer

required

The number of billing cycles for which this discount will be applied. After the recurring cycle limit is met the discount will be removed from the subscription.

Required range: x >= 1

paymentMethod

required

This field is expandable.

currencyCode

string

required

The currency that applies to both item prices and delivery price.

Required string length: 3

deliveryAddress

object

required

Show child attributes

deliveryAddress.firstName

null | string

required

Customer's first name.

Minimum string length: 1

deliveryAddress.lastName

null | string

required

Customer's last name.

Minimum string length: 1

deliveryAddress.address1

null | string

required

Primary street address.

Minimum string length: 1

deliveryAddress.address2

null | string

required

Additional address information (apartment, suite, etc.)

Minimum string length: 1

deliveryAddress.zip

null | string

required

Postal/ZIP code.

Minimum string length: 1

deliveryAddress.city

null | string

required

City name.

Minimum string length: 1

deliveryAddress.country

null | string

required

Full country name.

Minimum string length: 1

deliveryAddress.countryCode

null | string

required

Two-letter country code (ISO 3166-1).

Required string length: 2

deliveryAddress.provinceCode

null | string

required

Province/state code.

Minimum string length: 1

deliveryAddress.province

null | string

required

Full province/state name.

Minimum string length: 1

deliveryAddress.phone

null | string

required

Contact phone number.

Minimum string length: 1

deliveryAddress.company

null | string

required

Company name.

Minimum string length: 1

deliveryMethod

object

required

Show child attributes

deliveryMethod.type

enum<string>

required

Available options:

shipping,

local-delivery,

pickup

deliveryMethod.title

null | string

required

deliveryMethod.description

null | string

required

deliveryPrice

number

required

The delivery price for the upcoming renewal.

Required range: x >= 0

List subscriptions Cancel subscription

⌘I

Core Resources

Authorizations

Headers

Path Parameters

Body

Response