billing_plans

Creates, updates, deletes, gets or lists a billing_plans resource.

Overview

Name	billing_plans
Type	Resource
Id	vercel.integrations.billing_plans

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
id	string
name	string
cost	string
description	string
details	array
disabled	boolean	(false, true)
effective_date	string	(wire: effectiveDate)
highlighted_details	array	(wire: highlightedDetails)
initial_charge	string	(wire: initialCharge)
maximum_amount	string	(wire: maximumAmount)
maximum_amount_auto_purchase_per_period	string	(wire: maximumAmountAutoPurchasePerPeriod)
minimum_amount	string	(wire: minimumAmount)
payment_method_required	boolean	(false, true) (wire: paymentMethodRequired)
preauthorization_amount	number	(wire: preauthorizationAmount)
quote	array
scope	string	(installation, resource)
type	string	(prepayment, subscription)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	integration_id_or_slug, product_id_or_slug	integration_configuration_id, metadata, source, team_id, slug	Get a list of billing plans for an integration and product.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
integration_id_or_slug	string
product_id_or_slug	string
integration_configuration_id	string	(wire: integrationConfigurationId)
metadata	string
slug	string	The Team slug to perform the request on behalf of.
source	string
team_id	string	The Team identifier to perform the request on behalf of. (wire: teamId)

SELECT examples

list

Get a list of billing plans for an integration and product.

SELECT
id,
name,
cost,
description,
details,
disabled,
effective_date,
highlighted_details,
initial_charge,
maximum_amount,
maximum_amount_auto_purchase_per_period,
minimum_amount,
payment_method_required,
preauthorization_amount,
quote,
scope,
type
FROM vercel.integrations.billing_plans
WHERE integration_id_or_slug = '{{ integration_id_or_slug }}' -- required
AND product_id_or_slug = '{{ product_id_or_slug }}' -- required
AND integration_configuration_id = '{{ integration_configuration_id }}'
AND metadata = '{{ metadata }}'
AND source = '{{ source }}'
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;