BUbuttondown
Prices

Create Price

Changed on

Create a new price

post/prices

Request

  • Base URL
    https://api.buttondown.com/v1
  • URL
    https://api.buttondown.com/v1/prices
  • Auth
    API key in header Authorization

Request body

amountinteger nullable

The price amount in the smallest currency unit (e.g. cents).

cadence'year' | 'month' | 'one-time' | 'email' | 'week' required

The billing cadence for this price.

currencystring required

The three-letter ISO currency code (e.g. 'usd').

descriptionstring nullable

An optional human-readable description of the price.

maximum_amountinteger nullable

The maximum amount for pay-what-you-want prices.

minimum_amountinteger nullable

The minimum amount for pay-what-you-want prices.

product_idstring nullable

The ID of the Stripe product this price belongs to.

style'pay-what-you-want' | 'fixed' | 'usage-based' required

The pricing style: 'fixed', 'pay-what-you-want', or 'usage-based'.

suggested_amountinteger nullable

The suggested amount for pay-what-you-want prices.

Response

Created

amountinteger nullable

The price amount in the smallest currency unit (e.g. cents).

cadence'year' | 'month' | 'one-time' | 'email' | 'week' required

The billing cadence for this price.

currencystring required

The three-letter ISO currency code (e.g. 'usd').

descriptionstring nullable

An optional human-readable description of the price.

maximum_amountinteger nullable

The maximum amount for pay-what-you-want prices.

minimum_amountinteger nullable

The minimum amount for pay-what-you-want prices.

product_idstring nullable

The ID of the Stripe product this price belongs to.

style'pay-what-you-want' | 'fixed' | 'usage-based' required

The pricing style: 'fixed', 'pay-what-you-want', or 'usage-based'.

suggested_amountinteger nullable

The suggested amount for pay-what-you-want prices.

idstring required

The unique identifier of the price.

Changes

  • 228cc05ba97dRevision changes
    • info

      added the non-success response with the status

  • 13f3bc084194Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      response property amount list-of-types was widened by adding types null to media type application/json of response 201

    • breaking

      response property description list-of-types was widened by adding types null to media type application/json of response 201

    • breaking

      response property maximum_amount list-of-types was widened by adding types null to media type application/json of response 201

    • breaking

      response property minimum_amount list-of-types was widened by adding types null to media type application/json of response 201

    • breaking

      response property product_id list-of-types was widened by adding types null to media type application/json of response 201

    • breaking

      response property suggested_amount list-of-types was widened by adding types null to media type application/json of response 201

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      the endpoint scheme security PermissionAuthenticationRequirement was removed from the API

    • info

      api tag Prices added

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      added the non-success response with the status

    • info

      added to the response property allOf list for the response status

    • info

      added subschema #2 to the response property anyOf list for the response status

    • info

      removed the invalid_amount enum value from the response property for the response status

    • info

      removed the maximum_amount_too_high enum value from the response property for the response status

    • info

      removed the paid_subscriptions_uninitialized enum value from the response property for the response status

    • info

      removed the product_deleted enum value from the response property for the response status

    • info

      removed the suggested_amount_out_of_range enum value from the response property for the response status