pricingPlanSubscriptions

Archive a pricing plan subscription by resource ID

Requires the PRICING_PLAN_SUBSCRIPTION.STATUS.UPDATE permission.

post/v{version}/pricing-plan-subscriptions/{resourceId}/archive

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/pricing-plan-subscriptions/{resourceId}/archive
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

resourceIdstring required

The ID of the resource for which the action is posted.

Headers

x-platform-idstring

Platform ID.

Response

OK

object_typestring nullable
idstring nullable
created_atstring nullable
updated_atstring nullable
activated_atstring nullable
status'DRAFT' | 'ACTIVE' | 'VOID' | 'ARCHIVED' | 'CANCELLED'

The status of the subscription.

referencestring
namestring nullable
purchase_order_numberstring nullable

The uniquely assigned purchase order number.

customer_idstring

The ID of the customer.

customer_referencestring

The reference of the customer.

billing_entity_idstring nullable

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_referencestring nullable

The reference of the billing entity that is assigned to the subscription. If not set, the default platform value will be taken.

billing_currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'

The alphabetic currency code representing the type of currency used for billing. If not set, the default (platform) value will be taken.

auto_renewalboolean nullable

Indicates if the subscription renews automatically.

type'QUOTE' | 'BILLING' | 'TEMPLATE'
variant'DEFAULT' | 'FORWARD_BILLING' | 'SELF_BILLING' | 'SELLER'
billing_time'EXACT' | 'CALENDAR'

The moment the invoices for the subscription should be created. If not set, the default platform value will be taken.

combineboolean nullable

Indication whether invoices of different subscriptions should be combined, if possible. If not set, the default platform value will be taken.

quote_version_idstring nullable

The reference to the version of the quote where the subscription is linked to.

upgraded_from_pricing_plan_subscription_idstring nullable

The resource ID of the subscription that this subscription is upgraded from.

upgraded_to_pricing_plan_subscription_idstring nullable

The resource ID of the subscription that this subscription is upgraded to.

payment_acceptor_idsstring[] nullable

The resource ID(s) of the specific payment acceptors for the subscription

pending_review_pricing_plan_schedule_idsstring[] nullable

The resource IDs of the pricing plan schedules pending review, ordered by start_at.

descriptionstring nullable
init_invoice_on_holdboolean
payment_method_idstring

The ID of the payment method to be used to pay for invoices of this subscription.

pricing_plan_subscription_group_idstring nullable

The resource ID of the pricing plan subscription group where the subscription is part of

forward_customer_idstring nullable

The reference to the customer that needs to be used for the invoice (for FORWARD_BILLING)

forward_customer_referencestring nullable

The reference of the forward customer (for FORWARD_BILLING). An alternative to forward_customer_id.

display_invoice_sub_lines_per_processing_only_customerboolean nullable
replicate_meter_data_ingest_to_parentboolean nullable
show_original_customer_invoice_lineboolean nullable

Show an invoice line per (child) customer on the invoice of the forward_customer_id. Defaults to the platform setting. Only supported for variant FORWARD_BILLING

show_tax_per_line_itemboolean nullable

Show the tax per line item on the invoice. When not provided or true, the tax is shown per invoice line. When false, the tax is only summarized (per tax rate) at the invoice total. This is a display only setting; the tax is always calculated per line item

sales_tax_percentagestring nullable

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

Changes

No recorded changes to this operation across all 1 revision of this API.