Skip to content

Commit 40bacf1

Browse files
committed
chore: Update OpenAPI Specs
1 parent 5284076 commit 40bacf1

File tree

8 files changed

+3213
-2499
lines changed

8 files changed

+3213
-2499
lines changed

bapi/2021-02-05.yml

Lines changed: 187 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6834,6 +6834,48 @@ paths:
68346834
$ref: '#/components/responses/UnprocessableEntity'
68356835
'500':
68366836
$ref: '#/components/responses/ClerkErrors'
6837+
/billing/subscription_items/{subscription_item_id}/price_transition:
6838+
post:
6839+
operationId: CreateBillingPriceTransition
6840+
x-speakeasy-group: billing
6841+
x-speakeasy-name-override: createPriceTransition
6842+
tags:
6843+
- Billing
6844+
summary: Create a price transition for a subscription item
6845+
description: |-
6846+
Creates a price transition for the specified subscription item.
6847+
This may create an upcoming subscription item or activate immediately depending on plan and payer rules.
6848+
parameters:
6849+
- name: subscription_item_id
6850+
in: path
6851+
description: The ID of the subscription item to transition
6852+
required: true
6853+
schema:
6854+
type: string
6855+
requestBody:
6856+
description: Parameters for the price transition
6857+
required: true
6858+
content:
6859+
application/json:
6860+
schema:
6861+
$ref: '#/components/schemas/PriceTransitionRequest'
6862+
responses:
6863+
'200':
6864+
$ref: '#/components/responses/CommercePriceTransition'
6865+
'400':
6866+
$ref: '#/components/responses/ClerkErrors'
6867+
'401':
6868+
$ref: '#/components/responses/AuthenticationInvalid'
6869+
'403':
6870+
$ref: '#/components/responses/AuthorizationInvalid'
6871+
'404':
6872+
$ref: '#/components/responses/ResourceNotFound'
6873+
'409':
6874+
$ref: '#/components/responses/Conflict'
6875+
'422':
6876+
$ref: '#/components/responses/UnprocessableEntity'
6877+
'500':
6878+
$ref: '#/components/responses/ClerkErrors'
68376879
/organization_permissions:
68386880
get:
68396881
operationId: ListOrganizationPermissions
@@ -7403,7 +7445,7 @@ paths:
74037445
maxLength: 255
74047446
subject:
74057447
type: string
7406-
pattern: ^(user|org|mch)_\w{27}$
7448+
pattern: ^(user|org|mch|scim)_\w{27}$
74077449
claims:
74087450
nullable: true
74097451
scopes:
@@ -7590,7 +7632,7 @@ paths:
75907632
in: query
75917633
- schema:
75927634
type: string
7593-
pattern: ^(user|org|mch)_\w{27}$
7635+
pattern: ^(user|org|mch|scim)_\w{27}$
75947636
required: true
75957637
name: subject
75967638
in: query
@@ -7972,7 +8014,7 @@ paths:
79728014
maxLength: 255
79738015
subject:
79748016
type: string
7975-
pattern: ^(user|org|mch)_\w{27}$
8017+
pattern: ^(user|org|mch|scim)_\w{27}$
79768018
seconds_until_expiration:
79778019
type: number
79788020
nullable: true
@@ -11337,7 +11379,7 @@ components:
1133711379
The algorithms we support at the moment are [`bcrypt`](https://en.wikipedia.org/wiki/Bcrypt), [`bcrypt_sha256_django`](https://docs.djangoproject.com/en/4.0/topics/auth/passwords/), [`md5`](https://en.wikipedia.org/wiki/MD5), `pbkdf2_sha1`, `pbkdf2_sha256`, [`pbkdf2_sha256_django`](https://docs.djangoproject.com/en/4.0/topics/auth/passwords/),
1133811380
[`phpass`](https://www.openwall.com/phpass/), `md5_phpass`, [`scrypt_firebase`](https://firebaseopensource.com/projects/firebase/scrypt/),
1133911381
[`scrypt_werkzeug`](https://werkzeug.palletsprojects.com/en/3.0.x/utils/#werkzeug.security.generate_password_hash), [`sha256`](https://en.wikipedia.org/wiki/SHA-2),
11340-
[`ldap_ssha`](https://www.openldap.org/faq/data/cache/347.html) and the [`argon2`](https://argon2.online/) variants: `argon2i` and `argon2id`.
11382+
[`ldap_ssha`](https://www.openldap.org/faq/data/cache/347.html), the [`argon2`](https://argon2.online/) variants: `argon2i` and `argon2id`, and `sha512_symfony`, the SHA-512 variant of the [Symfony](https://symfony.com/doc/current/security/passwords.html) legacy hasher.
1134111383
1134211384
Each of the supported hashers expects the incoming digest to be in a particular format. See the [Clerk docs](https://clerk.com/docs/references/backend/user/create-user) for more information.
1134311385
TotalCount:
@@ -13431,6 +13473,141 @@ components:
1343113473
RFC3339 timestamp to extend the free trial to.
1343213474
Must be in the future and not more than 365 days from now.
1343313475
example: '2026-01-08T00:00:00Z'
13476+
PriceTransitionRequest:
13477+
type: object
13478+
additionalProperties: false
13479+
required:
13480+
- from_price_id
13481+
- to_price_id
13482+
properties:
13483+
from_price_id:
13484+
type: string
13485+
description: The current price ID of the subscription item.
13486+
to_price_id:
13487+
type: string
13488+
description: The target price ID to transition to.
13489+
CommercePriceResponse:
13490+
type: object
13491+
additionalProperties: false
13492+
required:
13493+
- object
13494+
- id
13495+
- plan_id
13496+
- instance_id
13497+
- currency
13498+
- currency_symbol
13499+
- amount
13500+
- annual_monthly_amount
13501+
- fee
13502+
- annual_monthly_fee
13503+
- created_at
13504+
properties:
13505+
object:
13506+
type: string
13507+
description: String representing the object's type. Objects of the same type share the same value.
13508+
enum:
13509+
- commerce_price
13510+
id:
13511+
type: string
13512+
description: Unique identifier for the price.
13513+
plan_id:
13514+
type: string
13515+
description: Unique identifier for the associated plan.
13516+
instance_id:
13517+
type: string
13518+
description: Unique identifier for the instance.
13519+
currency:
13520+
type: string
13521+
description: The currency code (e.g., "USD").
13522+
currency_symbol:
13523+
type: string
13524+
description: The currency symbol (e.g., "$").
13525+
amount:
13526+
type: integer
13527+
format: int64
13528+
description: The amount in cents for the price.
13529+
annual_monthly_amount:
13530+
type: integer
13531+
format: int64
13532+
description: The monthly amount in cents when billed annually.
13533+
fee:
13534+
$ref: '#/components/schemas/CommerceMoneyResponse'
13535+
annual_monthly_fee:
13536+
$ref: '#/components/schemas/CommerceMoneyResponse'
13537+
description:
13538+
type: string
13539+
nullable: true
13540+
description: The description of the price.
13541+
created_at:
13542+
type: integer
13543+
format: int64
13544+
description: Unix timestamp (milliseconds) of creation.
13545+
CommercePriceTransitionDetails:
13546+
type: object
13547+
additionalProperties: false
13548+
required:
13549+
- previous_plan
13550+
- previous_price
13551+
- effective_at
13552+
- effective_mode
13553+
- charged_immediately
13554+
- previous_subscription_item_status
13555+
- previous_subscription_item_id
13556+
properties:
13557+
previous_plan:
13558+
$ref: '#/components/schemas/CommercePlan'
13559+
previous_price:
13560+
$ref: '#/components/schemas/CommercePriceResponse'
13561+
effective_at:
13562+
type: integer
13563+
format: int64
13564+
description: Unix timestamp (milliseconds) when the new price takes effect.
13565+
effective_mode:
13566+
type: string
13567+
description: When the new price takes effect.
13568+
enum:
13569+
- immediate
13570+
- end_of_period
13571+
next_billing_date:
13572+
type: integer
13573+
format: int64
13574+
nullable: true
13575+
description: Unix timestamp (milliseconds) for the next billing date.
13576+
charged_immediately:
13577+
type: boolean
13578+
description: Whether an immediate charge was made.
13579+
immediate_charge:
13580+
allOf:
13581+
- $ref: '#/components/schemas/CommerceMoneyResponse'
13582+
nullable: true
13583+
description: Amount charged immediately, if any.
13584+
previous_subscription_item_status:
13585+
type: string
13586+
description: The status of the previous subscription item after transition.
13587+
enum:
13588+
- canceled
13589+
- ended
13590+
- abandoned
13591+
previous_subscription_item_id:
13592+
type: string
13593+
description: The ID of the previous subscription item.
13594+
CommercePriceTransitionResponse:
13595+
type: object
13596+
additionalProperties: false
13597+
required:
13598+
- object
13599+
- subscription_item
13600+
- transition
13601+
properties:
13602+
object:
13603+
type: string
13604+
description: String representing the object's type. Objects of the same type share the same value.
13605+
enum:
13606+
- commerce_price_transition
13607+
subscription_item:
13608+
$ref: '#/components/schemas/CommerceSubscriptionItem'
13609+
transition:
13610+
$ref: '#/components/schemas/CommercePriceTransitionDetails'
1343413611
Permission:
1343513612
type: object
1343613613
properties:
@@ -14259,6 +14436,12 @@ components:
1425914436
application/json:
1426014437
schema:
1426114438
$ref: '#/components/schemas/CommerceSubscriptionItem'
14439+
CommercePriceTransition:
14440+
description: A commerce price transition.
14441+
content:
14442+
application/json:
14443+
schema:
14444+
$ref: '#/components/schemas/CommercePriceTransitionResponse'
1426214445
Permissions:
1426314446
description: Success
1426414447
content:

0 commit comments

Comments
 (0)