Create subscription

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

Subscribes the customer you specify to your services with the pointed options

Error codes:


CustomerNotFound	There is no customer with ID specified in the request
ProductFamilyNotFound	There is no product family with ID specified in the request
PlanItemPriceNotFound	There is no plan with any of ids specified in “items” array
ItemPricesNotFound	some of ids in “items” array belong to product family item prices that cannot be found, or “discounts” array contains product family item prices that are not listed in “items” array
ItemPricesHasDifferentPricingModel	pricing model of some of the product family item prices is different from the pricing model specified in the request
ItemPricesHasOtherCurrency	currency of some of the product family item prices is different from the currency of the plan price specified in the request

Path Params

projectName

string

required

Defaults to your-site-name-1

Name of your project

Query Params

fullResponse

boolean

Defaults to false

Controls whether the API returns the complete response data, including created subscription and issued invoice (200 OK) , or a simplified version with only subscription id (201 Created). Default - false

Body Params

string

The id of the future subscription

customerId

string

required

The id of the customer to subscribe

startDate

date-time

The date when the subscription must start

channel

string

required

The channel this subscription will be paid by. Can be “Web”, “AppStore” or “PlayStore”

billingCycles

string

Billing cycles override. If not provided value configured for plan item price will be used.

billingPeriod

int32

Total number of subscription billing period. Applicable only for subscription with "Fixed" billing cycles. If not provided, value configured for plan item price will be used. Field is required when plan is configured as "Forever" but billingCycles was overriden to "Fixed"

autoCollection

string

Optional, on/off, default=off

invoiceNotes

string

A customer-facing note added to all invoices associated with this subscription. This note is one among all the notes displayed on the invoice PDF

usePendingPaymentFlow

boolean

required

Activate immediately or activate after payment

includeVat

boolean

required

Whether subscription items prices include VAT already

metadata

object

Key-value pairs of some additional information about the subscription

trialBillingPeriod

int32

Length of trial period, in trialBillingPeriodUnits

trialBillingPeriodUnit

string

Can be Day or Month

futureInvoiceDaysBeforeEndPeriod

int32

How many days before billing period end should be left to generate invoice

daysNotifyAboutUnpaidInvoice

array of int32s

How many days before invoice due date should be left to send a reminder about the invoice to the customer. There can be a few reminders sent

daysNotifyAboutUnpaidInvoice

discounts

array of objects

Discounts for subscription items

discounts

items

array of objects

Array of item prices which are applied to the subscription

items

Responses

Response body

object

subscription

object

string

customerId

string

currencyCode

string

productFamilyId

string

usePendingPaymentFlow

boolean

Defaults to true

futureInvoiceDaysBeforeEndPeriod

integer

Defaults to 0

daysNotifyAboutUnpaidInvoice

array of integers

daysNotifyAboutUnpaidInvoice

startDate

string

activatedDate

string

nextBillingDate

string

channel

string

billingCycles

string

billingPeriod

integer

Defaults to 0

autoCollection

string

status

string

metadata

object

mrr

integer

Defaults to 0

includeVat

boolean

Defaults to true

items

array of objects

items

object

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

discounts

array of objects

discounts

object

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

trialPeriod

object

frequency

object

initialBillingPeriod

integer

Defaults to 0

createdAt

string

updatedAt

string

cancellationDate

string

pendingPaymentInvoiceId

string

pendingPaymentReason

string

cancelledReason

string

cancelledCreditOption

string

version

integer

Defaults to 0

currentPeriodStartDate

string

hasSinglePaymentPlan

boolean

Defaults to true

hasScheduledChanges

boolean

Defaults to true

lastRenewalDate

string

isImported

boolean

Defaults to true

invoice

object

string

customerId

string

date

string

status

string

currencyCode

string

subscriptionId

string

singlePaymentId

string

issuedOn

string

voidedOn

string

paidOn

string

amountTotal

integer

Defaults to 0

amountSubTotal

integer

Defaults to 0

amountDiscount

integer

Defaults to 0

amountAdjusted

integer

Defaults to 0

amountPaid

integer

Defaults to 0

amountCreditsApplied

integer

Defaults to 0

amountDue

integer

Defaults to 0

taxRate

integer

Defaults to 0

amountTotalBeforeVat

integer

Defaults to 0

amountVat

integer

Defaults to 0

amountAdjustable

integer

Defaults to 0

amountRefundable

integer

Defaults to 0

dueDate

string

lineItems

array of objects

lineItems

object

string

description

string

entityType

string

entityId

string

fromDate

string

toDate

string

pricingModel

string

quantity

integer

Defaults to 0

unitAmount

integer

Defaults to 0

amount

integer

Defaults to 0

amountDiscount

integer

Defaults to 0

amountItemLevelDiscount

integer

Defaults to 0

taxRate

integer

Defaults to 0

linkedPayments

array of objects

linkedPayments

object

transactionId

string

transactionAmount

integer

Defaults to 0

transactionStatus

string

transactionDate

string

allocatedAmount

integer

Defaults to 0

allocatedAt

string

adjustmentCreditNotes

array of objects

adjustmentCreditNotes

object

string

date

string

status

string

reason

string

total

integer

Defaults to 0

issuedCreditNotes

array of objects

issuedCreditNotes

object

string

date

string

status

string

reason

string

total

integer

Defaults to 0

allocatedCredits

array of objects

allocatedCredits

object

creditNoteId

string

creditNoteReason

string

creditNoteDate

string

creditNoteStatus

string

allocatedAmount

integer

Defaults to 0

allocatedAt

string

lineItemDiscounts

array of objects

lineItemDiscounts

object

lineItemId

string

discountId

string

description

string

entityType

string

entityId

string

amount

integer

Defaults to 0

discounts

array of objects

discounts

object

string

description

string

discountType

string

lineItemId

string

entityType

string

entityId

string

amount

integer

Defaults to 0

productBillingInfo

object

customerBillingInfo

object

tax

object

Language

Credentials

Basic

base64


xxxxxxxxxx
11
1
curl --request POST \
2
     --url 'https://api.rainex.io/projects/your-site-name-1/subscriptions?fullResponse=false' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "channel": "Web",
8
  "usePendingPaymentFlow": true,
9
  "includeVat": true
10
}
11
'

Choose an example:

application/json

200200

201201

4XX4XX