api

Changed on

Get a public Subscription

get/api/public/subscriptions/{id}

Request

  • Base URL: https://vivenu.com
  • URL: https://vivenu.com/api/public/subscriptions/{id}
  • Auth: none declared

Path parameters

idstring required

Query parameters

secretstring required

Response

OK

_idstring required

The ID of the subscription

sellerIdstring required

The ID of the seller of the subscription

status'DRAFT' | 'ACTIVE' | 'INCOMPLETE' | 'CANCELED' | 'ARCHIVED' | 'PENDING-CANCELLATION' required

The status of the subscription

customerIdstring required

The ID of the customer of the subscription

planIdstring required

The ID of the plan of the subscription

currency'EUR' | 'USD' | 'GBP' | 'AUD' | 'CHF' | 'THB' | 'ILS' | 'COP' | 'MXN' | 'DKK' | 'NOK' | 'SEK' | 'QAR' | 'CAD' | 'ISK' | 'GTQ' | 'INR' | 'DOP' | 'SGD' | 'PLN' | 'SAR' | 'TTD' | 'ZAR' | 'KYD' | 'HKD' | 'CZK' | 'KRW' | 'JPY' | 'NZD' | 'AED' | 'MAD' | 'TWD' | 'BRL' | 'BWP' | 'NAD' | 'KES' | 'SCR' | 'TRY' | 'SZL' | 'LSL' | 'TZS' | 'UGX' | 'ZMW' | 'ZWG' | 'GHS' | 'NGN' | 'SLE' | 'LRD' | 'XOF' | 'XAF' | 'GEL' | 'IDR' | 'ARS' | 'CRC' | 'HUF' | 'EGP' | 'MYR' | 'VND' | 'PHP' | 'MWK' required

An ISO 4217 3-character code of the currency

customerPaymentMethodIdstring

The ID of the payment method of the subscription

transactionIdstring

The ID of the transaction of the subscription

startAtstring date-time

An ISO timestamp indicating when the subscription starts

cancelAtstring date-time

An ISO timestamp indicating when the subscription cancels

canceledAtstring date-time

An ISO timestamp indicating when the subscription was canceled

companystring

The company of the subscription holder

firstnamestring

The first name of the subscription holder

lastnamestring

The last name of the subscription holder

namestring

The name of the subscription holder

emailstring email

The email of the subscription holder

phonestring nullable

The phone number of the subscription holder

secretstring date-time

The secret token of the subscription

Changes

  • 4ef1e0466eb3Revision changes
    • breaking

      added subschema #1 subschema #2 to the /// response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the /// response property oneOf list for the response status

  • 269d998e6d11Revision changes
    • warning

      added the new subscription.billing_cycle_end_changed enum value to the // response property for the response status