Attributes

• idstring

  The ID of the LicenseFee.

• objectstring, value is "v2.billing.license_fee"

  String representing the object’s type. Objects of the same type share the same value of the object field.

• activeboolean

  Whether this LicenseFee is active. Inactive LicenseFees cannot be used in new activations or be modified.

• createdtimestamp

  Timestamp of when the object was created.

• currencystring

  The currency of this LicenseFee.

• display_namestring

  A customer-facing name for the LicenseFee. This name is used in Stripe-hosted products like the Customer Portal and Checkout. It does not show up on Invoices. Maximum length of 250 characters.

• latest_versionstring

  The ID of the LicenseFee’s most recently created version.

• licensed_itemobject

  The LicensedItem that this license fee binds to.

  Show child attributes

• live_versionstring

  The ID of the version that will be used by all Subscriptions when no specific version is specified.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• lookup_keynullable string

  An internal key you can use to search for a particular LicenseFee. Maximum length of 200 characters.

• metadatanullable map

  Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• service_intervalenum

  The interval for assessing service.

  Possible enum values

  day Assess service by days.

  month Assess service by months.

  week Assess service by weeks.

  year Assess service by years.

• service_interval_countinteger

  The length of the interval for assessing service. For example, set this to 3 and service_interval to "month" in order to specify quarterly service.

• tax_behaviorenum

  The Stripe Tax tax behavior - whether the license fee is inclusive or exclusive of tax.

  Possible enum values

  exclusive Price excludes tax.

  inclusive Price includes tax.

• tiering_modenullable enum

  Defines whether the tiering price should be graduated or volume-based. In volume-based tiering, the maximum quantity within a period determines the per-unit price. In graduated tiering, the pricing changes as the quantity grows into new tiers. Can only be set if tiers is set.

  Possible enum values

  graduated Use graduated tiering: the pricing at each tier applies to the quantity within that tier.

  volume Use volume-based tiering: the maximum quantity within a period determines the per-unit price for that period.

• tiersarray of objects

  Each element represents a pricing tier. Cannot be set if unit_amount is provided.

  Show child attributes

• transform_quantitynullable object

  Apply a transformation to the reported usage or set quantity before computing the amount billed.

  Show child attributes

• unit_amountnullable string

  The per-unit amount to be charged, represented as a decimal string in minor currency units with at most 12 decimal places. Cannot be set if tiers is provided.

Attributes

• idstring

  The ID of the LicenseFeeVersion.

• objectstring, value is "v2.billing.license_fee_version"

  String representing the object’s type. Objects of the same type share the same value of the object field.

• createdtimestamp

  Timestamp of when the object was created.

• license_fee_idstring

  The ID of the parent LicenseFee.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• tiering_modenullable enum

  Defines whether the tiering price should be graduated or volume-based. In volume-based tiering, the maximum quantity within a period determines the per-unit price. In graduated tiering, the pricing changes as the quantity grows into new tiers. Can only be set if tiers is set.

  Possible enum values

  graduated Use graduated tiering: the pricing at each tier applies to the quantity within that tier.

  volume Use volume-based tiering: the maximum quantity within a period determines the per-unit price for that period.

• tiersarray of objects

  Each element represents a pricing tier. Cannot be set if unit_amount is provided.

  Show child attributes

• transform_quantitynullable object

  Apply a transformation to the reported usage or set quantity before computing the amount billed.

  Show child attributes

• unit_amountnullable string

  The per-unit amount to be charged, represented as a decimal string in minor currency units with at most 12 decimal places. Cannot be set if tiers is provided.

Create a LicenseFee object.

Parameters

• currencystringRequired

  The currency of this LicenseFee.

• display_namestringRequired

  A customer-facing name for the LicenseFee. This name is used in Stripe-hosted products like the Customer Portal and Checkout. It does not show up on Invoices. Maximum length of 250 characters.

• licensed_itemstringRequired

  The LicensedItem that this rate binds to.

• service_intervalenumRequired

  The interval for assessing service. For example, a monthly LicenseFee with a rate of $1 for the first 10 “workloads” and $2 thereafter means “$1 per workload up to 10 workloads during a month of service.” This is similar to but distinct from billing interval; the service interval deals with the rate at which the customer accumulates fees, while the billing interval in Cadence deals with the rate the customer is billed.

  Possible enum values

  day Assess service by days.

  month Assess service by months.

  week Assess service by weeks.

  year Assess service by years.

• service_interval_countintegerRequired

  The length of the interval for assessing service. For example, set this to 3 and service_interval to "month" in order to specify quarterly service.

• tax_behaviorenumRequired

  The Stripe Tax tax behavior - whether the license fee is inclusive or exclusive of tax.

  Possible enum values

  exclusive Price excludes tax.

  inclusive Price includes tax.

• lookup_keystring

  An internal key you can use to search for a particular LicenseFee. Maximum length of 200 characters.

• metadatamap

  Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• tiering_modeenum

  Defines whether the tiered price should be graduated or volume-based. In volume-based tiering, the maximum quantity within a period determines the per-unit price. In graduated tiering, the pricing changes as the quantity grows into new tiers. Can only be set if tiers is set.

  Possible enum values

  graduated Use graduated tiering: the pricing at each tier applies to the quantity within that tier.

  volume Use volume-based tiering: the maximum quantity within a period determines the per-unit price for that period.

• tiersarray of objects

  Each element represents a pricing tier. Cannot be set if unit_amount is provided.

  Show child parameters

• transform_quantityobject

  Apply a transformation to the reported usage or set quantity before computing the amount billed.

  Show child parameters

• unit_amountstring

  The per-unit amount to be charged, represented as a decimal string in minor currency units with at most 12 decimal places. Cannot be set if tiers is provided.

Update a LicenseFee object.

Parameters

• display_namestringRequired

  A customer-facing name for the LicenseFee. This name is used in Stripe-hosted products like the Customer Portal and Checkout. It does not show up on Invoices. Maximum length of 250 characters.

• idstringRequired

  The ID of the LicenseFee to update.

• live_versionstring

  Changes the version that new LicenseFee will use. Providing live_version = "latest" will set the LicenseFee’s live_version to its latest version.

• lookup_keystring

  An internal key you can use to search for a particular LicenseFee. Maximum length of 200 characters.

• metadatamap

  Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• tiering_modeenum

  Defines whether the tiered price should be graduated or volume-based. In volume-based tiering, the maximum quantity within a period determines the per-unit price. In graduated tiering, the pricing changes as the quantity grows into new tiers. Can only be set if tiers is set.

  Possible enum values

  graduated Use graduated tiering: the pricing at each tier applies to the quantity within that tier.

  volume Use volume-based tiering: the maximum quantity within a period determines the per-unit price for that period.

• tiersarray of objects

  Each element represents a pricing tier. Cannot be set if unit_amount is provided.

  Show child parameters

• transform_quantityobject

  Apply a transformation to the reported usage or set quantity before computing the amount billed.

  Show child parameters

• unit_amountstring

  The per-unit amount to be charged, represented as a decimal string in minor currency units with at most 12 decimal places. Cannot be set if tiers is provided.