Update non-financial charge details

put

https://api.app.subskribe.com/plans/{planId}/charges/{chargeId}/partial

Updates certain details of the specified charge which won't impact its financial treatment

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

planId

string

required

id of the plan

chargeId

string

required

id of the charge

Body Params

JSON object representing the charge details.

name

string

required

Name of the charge

displayName

string

Display name of the charge shown to customers

description

string

Detailed description of the charge

taxRateId

uuid

ID of the tax rate applied to this charge. To get a list of available tax rate IDs, call the Get tax rates operation. DEPRECATED: Use taxRateStrategyId instead. (deprecated: use taxRateStrategyId)

taxRateStrategyId

string

ID of the tax rate strategy applied to this charge. This determines how taxes are calculated when multiple tax rates apply.

unitOfMeasureId

uuid

ID of the unit of measure for this charge (e.g., GB, users, licenses). To get a list of available unit of measure IDs, call the Get units of measure operation.

isRenewable

boolean

Indicates if the charge is renewable

isCreditable

boolean

Indicates if the charge can be credited

isListPriceEditable

boolean

Indicates if the list price can be edited

minQuantity

int64

Minimum quantity that must be ordered. Applicable only if the chargeModel is PER_UNIT or RATE_CARD_LOOKUP.

defaultQuantity

int64

Default quantity for this charge. Applicable only if the chargeModel is PER_UNIT or RATE_CARD_LOOKUP.

maxQuantity

int64

Maximum quantity that can be ordered. Applicable only if the chargeModel is PER_UNIT or RATE_CARD_LOOKUP.

externalId

string

External identifier for the charge, used for integration with other systems

minAmount

number

NOTE: This parameter is currently in beta
Minimum monetary amount for this charge. Applies only when type is PERCENTAGE_OF.

maxAmount

number

NOTE: This parameter is currently in beta
Maximum monetary amount for this charge. Applies only when type is PERCENTAGE_OF.

recognitionRuleId

string

ID of the revenue recognition rule associated with this charge

erpId

string

ERP system identifier for this charge

itemCode

string

Item code used for this charge in external systems

targetPlanIds

array of strings

List of plan IDs that this PERCENTAGE_OF charge applies to

targetPlanIds

creditable

boolean

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200successful operation