v1

latestOpenAPI 3.0.02026-07-14205154.3 KB

Subscriptions

List subscriptions

List subscriptions filtering by some arguments.

get/api/rns/pub/subscriptions

customerEmailstring nullable

Customer that owns the subscription. Defaults to the current logged user.

statusstring nullable

Current subscription status

addressIdstring nullable

Id from the address used as shipping address

paymentIdstring nullable

Id from the payment used as payment method

planIdstring nullable

Id from the plan that the subscription belongs to

nextPurchaseDatestring nullable

Date for the next cycle

originalOrderIdstring nullable

Id from the order that generated the subscription

pageinteger

Page used for pagination

sizeinteger

Page size used for pagination

Content-Typestring required

Example:application/json

Type of the content being sent.

Acceptstring required

Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Requested subscriptions

createdAtstring date-time required

customerEmailstring nullable required

customerIdstring nullable required

cycleCountinteger required

idstring nullable required

isSkippedboolean required

lastPurchaseDatestring date-time nullable

lastUpdatestring date-time required

nextPurchaseDatestring date-time required

statusstring nullable required

titlestring nullable

[
  {
    "items": [
      {
        "manualPrice": 40,
        "quantity": 5,
        "skuId": "12"
      }
    ]
  }
]