Skip to main content
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": null,
    "lastName": null,
    "address1": null,
    "address2": null,
    "zip": null,
    "city": null,
    "country": null,
    "countryCode": null,
    "provinceCode": null,
    "province": null,
    "phone": null,
    "company": null
  },
  "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": null,
  "customer": "<string>",
  "nextBillingDate": null,
  "currentCycle": 1,
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resource": "subscription-item",
      "title": "<string>",
      "subtitle": null,
      "quantity": 2,
      "totalPrice": 1,
      "variant": "<string>",
      "recurringCycleLimit": null,
      "canceledAt": null
    }
  ],
  "discounts": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resource": "subscription-discount",
      "title": null,
      "target": {
        "type": "shipping"
      },
      "value": {
        "amount": 123,
        "type": "fixed-amount",
        "appliesOnEachItem": true
      },
      "recurringCycleLimit": null
    }
  ],
  "paymentMethod": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currencyCode": "<string>",
  "deliveryAddress": null,
  "deliveryMethod": null,
  "deliveryPrice": 1
}

Authorizations

​
X-Juo-Admin-Api-Key
string
header
required

Headers

​
X-Tenant-ID
string
required

Path Parameters

​
subscriptionId
string<uuid>
required

Body

application/json
​
deliveryPrice
number
Required range: x >= 0
​
paymentMethod
string<uuid>
​
deliveryAddress
object
​
deliveryMethod
object
​
nextBillingDate

Response

200 - application/json
​
id
string<uuid>
required
​
resource
enum<string>
required
Available options:
subscription
​
serial
string
required
Minimum length: 1
​
status
enum<string>
required
Available options:
active,
paused,
canceled,
failed,
expired,
merged
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
canceledAt
string<date-time> | null
required
​
customer
required
Minimum length: 1
​
nextBillingDate
string<date-time> | null
required
​
currentCycle
integer
required
Required range: x >= 0
​
items
SubscriptionItem · object[]
required
Minimum length: 1
​
discounts
SubscriptionDiscount · object[]
required
​
paymentMethod
required
​
currencyCode
string
required
Required string length: 3
​
deliveryAddress
object | null
required
​
deliveryMethod
object | null
required
​
deliveryPrice
number
required
Required range: x >= 0