Pause a Subscription

Create a Subscription Pause

Create pause for subscription or otherwise stop subscription billing for a time. Pause subscription for specific period. Pause can have overlapping and any number of days, if they are meet criteria in limits section.

PUT /v1/clients/{{ClientID}}/subscriptions/{{SubscriptionID}}/pauses/{{PauseID}}

  • ClientID = Your Riverty client_i
  • SubscriptionID = The Subscription I
  • PauseID = Assign your internal reference to this pause.

Call Example

{
  "from": "2055-09-13",
  "until": "2055-09-19",
  "description": "Pause for 1 week"
}

Response Example

{
  "id": "PauseId",
  "from": "2055-09-13",
  "until": "2055-09-19",
  "description": "Pause for 1 week"
}

Limitations

  1. Pause is not allowed for subscription product with financing type ‘Contract’.
  2. Pause only allowed for ‘Active’ subscription.
  3. Pause cannot be applied to trial period.
  4. Pause cannot be applied for already invoiced periods.
  5. Per year only ‘92’ allowed to pause (currently not configurable, hard coded in code).
  6. Pause cannot be edited or deleted if it is contains already invoice period.

Delete a Subscription Pause

Delete a specific pause

GET /v1/clients/{{ClientID}}/subscriptions/{{SubscriptionID}}/pauses/{{PauseID}}

  • ClientID = Your Riverty client_id
  • SubscriptionID = The Subscription ID
  • PauseID = Assign your internal reference to this pause.

API response example

Status Code: 200

Get a Subscription Pause

Get pause details for specific subscription.

GET /v1/clients/{{ClientID}}/subscriptions/{{SubscriptionID}}/pauses/{{PauseID}}

  • ClientID = Your Riverty client_id
  • SubscriptionID = The Subscription ID
  • PauseID = Assign your internal reference to this pause.

Response Example

{
  "id": "PauseId",
  "from": "2055-09-13",
  "until": "2055-09-19",
  "description": "Pause for 1 week"
}

Get all Subscription Pauses

Get all subscription pauses for specific subscription

GET /v1/clients/{{ClientID}}/subscriptions/{{SubscriptionID}}/pauses

  • ClientID = Your Riverty client_id
  • SubscriptionID = The Subscription ID

Response Example

[
  {
    "id": "PauseId_1",
    "from": "2055-09-13",
    "until": "2055-09-19",
    "description": "Pause for 1 week"
  },
  {
    "id": "PauseId_2",
    "from": "2055-10-11",
    "until": "2055-10-17",
    "description": "Pause for 1 week"
  }
]