post-api2-dashboard-subscription

Renew Subscription

​

This API allows the business to renew subscriptions by making back-end calls on the designated date of renewal registered on the business end.

Headers
  • Content-Type
    Type: string
    required

    application/json

  • Accept
    Type: string
    required

    application/json

  • Authorization
    Type: string
    required

    Bearer token for admin authorization, who is making a call on behalf of the customer

Body
application/json
  • end_time
    Type: string
    min length:  
    1    Format: date-time
    required

    Date and time (in ISO 8601 format) until which the renewed subscription will remain active

  • new_plan_id
    Type: integer

    This is sent only if the guest wants to switch to a different subscription plan (e.g., changing from a monthly plan to a quarterly plan)

  • purchase_price
    Type: numberFormat: float
    required

    Cost of renewal of one unit of the subscription plan that is being renewed

  • start_time
    Type: string
    min length:  
    1    Format: date-time
    required

    Date and time (in ISO 8601 format) from which the renewed subscription will become active

  • subscription_id
    Type: integer
    required

    Unique ID of the subscription plan that was issued to the guest and is being renewed

Responses
  • 200
    Type: object
    • end_time
      Type: string
      min length:  
      1      Format: date-time
      required

      Date and time (in ISO 8601 format) from until which the renewed subscription will remain active

    • external_plan_identifier
      Type: string

      UPC/SKU of the subscription plan as present on third-party applications of enterprise businesses and is configured on this subscription plan. This will be stored in the database, and the business can use it for analytics purposes.

    • start_time
      Type: string
      min length:  
      1      Format: date-time
      required

      Date and time (in ISO 8601 format) from which the renewed subscription will become active

    • subscription_id
      Type: integer
      required

      System-generated unique ID of the subscription that is issued for a guest

  • 401
    Type: object
    • error
      Type: string
      min length:  
      1
      required
  • 406
    Type: object
    • invalid
      Type: string
      min length:  
      1
  • 422
    Type: object
    • errors
      Type: object
post/api2/dashboard/subscriptions/renew
{
  "subscription_id": 40,
  "start_time": "2021-04-20T21:09:38Z",
  "end_time": "2021-04-20T21:09:38Z",
  "external_plan_identifier": "string"
}

OK