Update or create a pricing plan subscription (upsert)
Update or create a pricing plan subscription (upsert)
Requires the PRICING_PLAN_SUBSCRIPTION.CREATE, QUOTE.PRICING_PLAN_SUBSCRIPTION.CREATE, PRICING_PLAN_SUBSCRIPTION.UPDATE or QUOTE.PRICING_PLAN_SUBSCRIPTION.UPDATE permission.
Authentication
X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
version
version
Headers
x-platform-id
Platform ID.
Query parameters
identifier_field
Which field to use to identify whether the resource exists or not
custom_field_reference
Which custom field to use to identify whether the resource exists or not
field_actions
The list of actions for specific fields.
Request
This endpoint expects an object.
reference
customer_id
The ID of the customer.
customer_reference
The reference of the customer.
billing_currency
The alphabetic currency code representing the type of currency used for billing. If not set, the default (platform) value will be taken.
variant
Allowed values:
init_invoice_on_hold
payment_method_id
The ID of the payment method to be used to pay for invoices of this subscription.
status
The status of the subscription.
Allowed values:
name
purchase_order_number
The uniquely assigned purchase order number.
customer
billing_entity_id
The resource ID of the billing entity that is assigned to the subscription. If not set, the default platform value will be taken.
billing_entity_reference
The reference of the billing entity that is assigned to the subscription. If not set, the default platform value will be taken.
billing_entity
billing_period
The renewal term after the initial term.
due_date_configuration
The configuration of the due date of the invoices in the subscriptions. If not set, the default (platform) value will be taken.
initial_term
The renewal term after the initial term.
renewal_term
The renewal term after the initial term.
auto_renewal
Indicates if the subscription renews automatically.
type
Allowed values:
billing_time
The moment the invoices for the subscription should be created. If not set, the default platform value will be taken.
Allowed values:
combine
Indication whether invoices of different subscriptions should be combined, if possible. If not set, the default platform value will be taken.
quote_version_id
The reference to the version of the quote where the subscription is linked to.
payment_acceptor_ids
The resource ID(s) of the specific payment acceptors for the subscription
description
custom_fields
pricing_plan_subscription_group_id
The resource ID of the pricing plan subscription group where the subscription is part of
pricing_plan_subscription_group
forward_customer_id
The reference to the customer that needs to be used for the invoice (for FORWARD_BILLING)
forward_customer
display_invoice_sub_lines_per_processing_only_customer
replicate_meter_data_ingest_to_parent
sales_tax_percentage
Sales tax for this subscription. If provided, it will override the tax for all items on the invoice. Mandatory for US to US billing when there's no external tax integration. Optional otherwise
next_invoice
template
The configuration fields that can be used when having a template subscription.
linked_integrations
Response
Created
reference
customer_id
The ID of the customer.
customer_reference
The reference of the customer.
billing_currency
The alphabetic currency code representing the type of currency used for billing. If not set, the default (platform) value will be taken.
variant
Allowed values:
init_invoice_on_hold
payment_method_id
The ID of the payment method to be used to pay for invoices of this subscription.
object_type
id
created_at
updated_at
activated_at
status
The status of the subscription.
Allowed values:
name
purchase_order_number
The uniquely assigned purchase order number.
customer
billing_entity_id
The resource ID of the billing entity that is assigned to the subscription. If not set, the default platform value will be taken.
billing_entity_reference
The reference of the billing entity that is assigned to the subscription. If not set, the default platform value will be taken.
billing_entity
billing_period
The renewal term after the initial term.
due_date_configuration
The configuration of the due date of the invoices in the subscriptions. If not set, the default (platform) value will be taken.
initial_term
The renewal term after the initial term.
renewal_term
The renewal term after the initial term.
auto_renewal
Indicates if the subscription renews automatically.
type
Allowed values:
billing_time
The moment the invoices for the subscription should be created. If not set, the default platform value will be taken.
Allowed values:
combine
Indication whether invoices of different subscriptions should be combined, if possible. If not set, the default platform value will be taken.
quote_version_id
The reference to the version of the quote where the subscription is linked to.
upgraded_from_pricing_plan_subscription_id
The resource ID of the subscription that this subscription is upgraded from.
upgraded_to_pricing_plan_subscription_id
The resource ID of the subscription that this subscription is upgraded to.
payment_acceptor_ids
The resource ID(s) of the specific payment acceptors for the subscription
payment_acceptors
pricing_plan_schedule_infos
description
custom_fields
pricing_plan_subscription_group_id
The resource ID of the pricing plan subscription group where the subscription is part of
pricing_plan_subscription_group
forward_customer_id
The reference to the customer that needs to be used for the invoice (for FORWARD_BILLING)
forward_customer
inactive_periods
display_invoice_sub_lines_per_processing_only_customer
replicate_meter_data_ingest_to_parent
sales_tax_percentage
Sales tax for this subscription. If provided, it will override the tax for all items on the invoice. Mandatory for US to US billing when there's no external tax integration. Optional otherwise
next_invoice
template
The configuration fields that can be used when having a template subscription.
linked_integrations
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error