INinvoiceninja
subscriptions

Updates an subscriptions

Changed on

Handles the updating of an subscriptions by id

put/api/v1/subscriptions/{id}

Request

Path parameters

idstring string required

The Subscription Hashed ID

Query parameters

includestring
Example:first_load

Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes

Headers

X-API-TOKENstring required
Example:TOKEN

The API token to be used for authentication

X-Requested-Withstring required
Example:XMLHttpRequest

Used to send the XMLHttpRequest header

Response

Returns the subscriptions object

idstring

Unique identifier for the subscription

user_idstring

Unique identifier for the user associated with the subscription

product_idstring

Unique identifier for the product associated with the subscription

recurring_invoice_idstring

Unique identifier for the recurring invoice associated with the subscription

is_recurringboolean

Indicates whether the subscription is recurring

frequency_idstring

integer const representation of the frequency

auto_billstring

enum setting

promo_codestring

Promotional code applied to the subscription

promo_discountnumber

Discount percentage or amount applied to the subscription

is_amount_discountboolean

Indicates whether the discount is a fixed amount

allow_cancellationboolean

Indicates whether the subscription can be cancelled

per_seat_enabledboolean

Indicates whether the subscription pricing is per seat

currency_idinteger

Unique identifier for the currency used in the subscription

max_seats_limitinteger

Maximum number of seats allowed for the subscription

trial_enabledboolean

Indicates whether the subscription has a trial period

trial_durationinteger

Duration of the trial period in days

allow_query_overridesboolean

Indicates whether query overrides are allowed for the subscription

allow_plan_changesboolean

Indicates whether plan changes are allowed for the subscription

refund_periodinteger

Number of days within which refunds can be requested

webhook_configurationstring

Webhook configuration for the subscription

is_deletedboolean

Indicates whether the subscription has been deleted

archived_atnumber

Timestamp

created_atnumber

Timestamp

updated_atnumber

Timestamp

Example response

{
  "id": "Opnel5aKBz",
  "user_id": "Ua6Rw4pVbS",
  "product_id": "Pr5Ft7yBmC",
  "recurring_invoice_id": "Ri2Yt8zJkP",
  "is_recurring": true,
  "frequency_id": "1",
  "auto_bill": "always",
  "promo_code": "PROMOCODE4U",
  "promo_discount": 10,
  "is_amount_discount": true,
  "allow_cancellation": true,
  "per_seat_enabled": true,
  "currency_id": 1,
  "max_seats_limit": 100,
  "trial_enabled": true,
  "trial_duration": 14,
  "allow_query_overrides": true,
  "allow_plan_changes": true,
  "refund_period": 30,
  "webhook_configuration": "expand reference for this",
  "archived_at": 1434342123,
  "created_at": 134341234234,
  "updated_at": 134341234234
}

Changes

  • 69a36036d334Revision changes
    • info

      the response optional property became read-only for the status

  • 8e82a2bd77e0Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status