Update Subscription Product

put

https://secure.fusebill.com/v1/SubscriptionProducts

This function will allow you to edit a Subscription Product Item in a specific Subscription Product in a specific Subscription for a Customer.

Note, setting the PriceUpliftsEnabled key-value to "False" from a previous value of "True" will delete existing, future and historical price uplifts.

Query Params

preview

boolean

If true, then the subscription product will not be changed. The JSON returned will show how the subscription product would be changed if the update actually occurred. Included in the response would be an invoicePreview object, since the update may result in an invoice being posted, such as a change to quantity.

temporarilyDisableAutoPost

boolean

If the customer is set up to have their invoices auto-post, this can be used to exclude the invoice which may be generated from this call from that process. The invoice generated would instead be a ready draft invoice.

Body Params

quantity

double

This is the quantity of this Subscription Product being purchased. Used by the pricing model and price ranges to calculate the overall price.

isIncluded

boolean

Controls whether this subscription product is included if the plan product is optional.

startDate

date-time

Controls scheduling for when this product generates charges. Can only be changed before the subscription has charges.

subscriptionProductOverride

object

Used to override name and description.

subscriptionProductPriceOverride

array

Used to override pricing details.

subscriptionProductPriceOverride

chargeAtSubscriptionActivation

boolean

Controls whether this subscription product will charge at activation. Can only be changed before the subscription has charges.

subscriptionProductDiscount

object

Used to add a discount on the subscription product.

earningSettings

object

Controls how this subscription product earns.

remainingInterval

int32

The number of intervals until this subscription product expires.

upliftPriorToRecharge

boolean

Controls whether price uplifts occur just prior to recharge.

includingInitialCharge

boolean

Controls whether the initial charge counts when timing price uplifts.

priceUpliftsEnabled

boolean

Controls whether price uplifts are being used for this subscription product.

priceUplifts

object

A schedule of price uplifts.

customServiceDateNumberOfIntervals

int32

Service dates control the dates displayed on invoice below the line item representing this subscription product on this plan frequency. This indicates how many intervals away from the invoice date is to be displayed.

customServiceDateInterval

string

enum

Service dates control the dates displayed on invoice below the line item representing this subscription product. This controls whether the distance from the invoice date is measured in days or periods.

Allowed:

customServiceDateProjection

string

enum

Service dates control the dates displayed on invoice below the line item representing this plan product on this plan frequency. This controls whether the service date is before the posted invoice, or after.

Allowed:

generateZeroDollarCharge

boolean

Indicates whether this subscription product should generate a charge if it is zero dollars.

int32

The Fusebill generated ID that uniquely identifies this subscription product.

Responses

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

200200

400400