Update a subscription by id

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

Updates current term ends date of a subscription with the specified 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
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

Path Params

projectName

string

required

Defaults to your-site-name-1

Name of your project

string

required

Subscription id

Body Params

startDate

date-time

The date when the subscription must start

billingCycles

string

required

Can be Fixed or Forever

billingPeriod

int32

Count billing Cycles. Required when billingCycles is Fixed

autoCollection

string

Optional, on/off, default=off

autoCollection_v2

string

Obsolete. Use "autoCollection" parameter instead.

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

metadata

object

Key-value pairs of some additional information about the subscription

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

newDiscounts

array of objects

new Discounts for subscription items

newDiscounts

items

array of objects

required

Array of item prices which are applied to the subscription

items*

addOneTimeCharges

array of objects

addOneTimeCharges

deletedDiscountIds

array of strings

Discounts that have been removed

deletedDiscountIds

changeOption

string

Change options (Obsolete)

applyOptions

object

The options describe how to change the subscription. Describes when to apply changes, how to issue a corrective invoice and how to issue credit notes

Responses

Response body

object

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

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

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

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

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

string

version

integer

Defaults to 0

currentPeriodStartDate

string

hasSinglePaymentPlan

boolean

Defaults to true

Language

Credentials

Basic

base64


xxxxxxxxxx
14
1
curl --request PUT \
2
     --url https://api.rainex.io/projects/your-site-name-1/subscriptions/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "billingCycles": "Fixed",
8
  "applyOptions": {
9
    "chargesOption": "prorate",
10
    "creditsOption": "prorate",
11
    "expirationDate": "null"
12
  }
13
}
14
'

Choose an example:

application/json

200200

4XX4XX