Get subscription by id

get https://api.rainex.io/projects/{projectName}/subscriptions/{id}

Here are the enums that are contained in the answer:

name	value
status	Future, InTrial, Active, NonRenewing, Paused, Cancel, Deleted, PendingPayment
billingCycles	Forever, Fixed
discounts[type]	FixedAmount, Percentage
discounts[applyOn]	InvoiceAmount, SpecificItemPrice
discounts[durationType]	OneTime, Forever
items[status]	Active
items[chargeOnEvent]	SubscriptionCreation, SubscriptionActivation, Immediately

Error codes:


NotFound	A subscription with such an Id cannot be found.

Responses

Response body

object

id

string

customerId

string

currencyCode

string

productFamilyId

string

usePendingPaymentFlow

boolean

Defaults to true

futureInvoiceDaysBeforeEndPeriod

integer

Defaults to 0

daysNotifyAboutUnpaidInvoice

array of integers

daysNotifyAboutUnpaidInvoice

projectFrequencyId

string

startDate

string

activatedDate

string

nextBillingDate

string

channel

string

billingCycles

string

billingPeriod

integer

Defaults to 0

autoCollection

string

status

string

invoiceNotes

string

metadata

object

additionalProp1

string

additionalProp2

string

additionalProp3

string

trialPeriod

object

billingPeriod

integer

Defaults to 0

billingPeriodUnit

string

amount

integer

Defaults to 0

mrr

integer

Defaults to 0

includeVat

boolean

Defaults to true

initialBillingPeriod

integer

Defaults to 0

createdAt

string

createdBy

string

updatedAt

string

cancellationDate

string

discounts

array of objects

discounts

object

id

integer

Defaults to 0

type

string

applyOn

string

durationType

string

value

integer

Defaults to 0

itemPriceId

string

subscriptionId

string

isUsed

boolean

Defaults to true

createdAt

string

createdBy

string

updatedAt

string

items

array of objects

items

object

id

string

itemPriceId

string

itemPriceName

string

itemPriceExternalName

string

freeQuantity

integer

Defaults to 0

quantity

integer

Defaults to 0

unitPrice

integer

Defaults to 0

amount

integer

Defaults to 0

chargeOnEvent

string

chargeOnce

boolean

Defaults to true

servicePeriodDays

integer

Defaults to 0

status

string

type

string

isUsed

boolean

Defaults to true

createdAt

string

createdBy

string

updatedAt

string

hasUnBilledChanges

boolean

Defaults to true

usedOneTimesCharges

array of objects

usedOneTimesCharges

object

id

string

itemPriceId

string

itemPriceExternalName

string

itemPriceName

string

freeQuantity

integer

Defaults to 0

quantity

integer

Defaults to 0

amount

integer

Defaults to 0

unitPrice

integer

Defaults to 0

chargeOnEvent

string

servicePeriodDays

string

createdAt

string

appliedDiscounts

array of objects

appliedDiscounts

object

id

string

type

string

value

integer

Defaults to 0

pendingPaymentInvoiceId

string

pendingPaymentReason

string

cancelledReason

string

cancelledCreditOption

string

frequency

object

unitOfMeasurement

string

quantity

integer

Defaults to 0

id

string

version

integer

Defaults to 0

currentPeriodStartDate

string

hasSinglePaymentPlan

boolean

Defaults to true

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.rainex.io/projects/your-site-name-1/subscriptions/id \
3
     --header 'accept: application/json'

Choose an example:

application/json