Skip to content

Commit

Permalink
OpenAPI Update (#1027)
Browse files Browse the repository at this point in the history 
Update OpenAPI for 49243f1b7f10923b168e103a467ecd3e6b4b5b5b

Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com>
  • Loading branch information
@stripe-openapi
stripe-openapi[bot] authored Nov 26, 2024
1 parent 8f1bf92 commit bf4a418
Showing 1 changed file with 27 additions and 27 deletions.
54 changes: 27 additions & 27 deletions embedded/openapi/spec3.beta.sdk.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5602,7 +5602,7 @@
}
},
"effective_at": {
"description": "The time when the billing credits become effective—when they're eligible for use.",
"description": "The time when the billing credits become effective-when they're eligible for use.",
"format": "unix-time",
"nullable": true,
"type": "integer"
Expand Down Expand Up @@ -5769,7 +5769,7 @@
}
},
"billing.meter": {
"description": "A billing meter is a resource that allows you to track usage of a particular event. For example, you might create a billing meter to track the number of API calls made by a particular user. You can then attach the billing meter to a price and attach the price to a subscription to charge the user for the number of API calls they make.\n\nRelated guide: [Usage based billing](https://docs.stripe.com/billing/subscriptions/usage-based)",
"description": "Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill.\n\nRelated guide: [Usage based billing](https://docs.stripe.com/billing/subscriptions/usage-based)",
"properties": {
"created": {
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
Expand Down Expand Up @@ -6052,7 +6052,7 @@
}
},
"billing.meter_event": {
"description": "A billing meter event represents a customer's usage of a product. Meter events are used to bill a customer based on their usage.\nMeter events are associated with billing meters, which define the shape of the event's payload and how those events are aggregated for billing.",
"description": "Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event’s payload and how to aggregate those events.",
"properties": {
"created": {
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
Expand Down Expand Up @@ -6515,7 +6515,7 @@
"description": "",
"properties": {
"price_type": {
"description": "The price type for which credit grants can apply. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.",
"description": "The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.",
"enum": [
"metered"
],
Expand Down Expand Up @@ -99706,7 +99706,7 @@
},
"/v1/billing/credit_balance_summary": {
"get": {
"description": "<p>Retrieves the credit balance summary for a customer</p>",
"description": "<p>Retrieves the credit balance summary for a customer.</p>",
"operationId": "GetBillingCreditBalanceSummary",
"parameters": [
{
Expand Down Expand Up @@ -99747,7 +99747,7 @@
"description": "The billing credit applicability scope for which to fetch credit balance summary.",
"properties": {
"price_type": {
"description": "The price type for which credit grants can apply. We currently only support the `metered` price type.",
"description": "The price type that credit grants can apply to. We currently only support the `metered` price type.",
"enum": [
"metered"
],
Expand Down Expand Up @@ -99831,7 +99831,7 @@
},
"/v1/billing/credit_balance_transactions": {
"get": {
"description": "<p>Retrieve a list of credit balance transactions</p>",
"description": "<p>Retrieve a list of credit balance transactions.</p>",
"operationId": "GetBillingCreditBalanceTransactions",
"parameters": [
{
Expand Down Expand Up @@ -99986,7 +99986,7 @@
},
"/v1/billing/credit_balance_transactions/{id}": {
"get": {
"description": "<p>Retrieves a credit balance transaction</p>",
"description": "<p>Retrieves a credit balance transaction.</p>",
"operationId": "GetBillingCreditBalanceTransactionsId",
"parameters": [
{
Expand Down Expand Up @@ -100198,7 +100198,7 @@
"summary": "List credit grants"
},
"post": {
"description": "<p>Creates a credit grant</p>",
"description": "<p>Creates a credit grant.</p>",
"operationId": "PostBillingCreditGrants",
"requestBody": {
"content": {
Expand Down Expand Up @@ -100276,7 +100276,7 @@
"description": "Specify the scope of this applicability config.",
"properties": {
"price_type": {
"description": "The price type for which credit grants can apply. We currently only support the `metered` price type.",
"description": "The price type that credit grants can apply to. We currently only support the `metered` price type.",
"enum": [
"metered"
],
Expand Down Expand Up @@ -100316,7 +100316,7 @@
"type": "string"
},
"effective_at": {
"description": "The time when the billing credits become effective—when they're eligible for use. Defaults to the current timestamp if not specified.",
"description": "The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified.",
"format": "unix-time",
"type": "integer"
},
Expand All @@ -100329,15 +100329,15 @@
"type": "array"
},
"expires_at": {
"description": "The time when the billing credits will expire. If not specified, the billing credits don't expire.",
"description": "The time when the billing credits expire. If not specified, the billing credits don't expire.",
"format": "unix-time",
"type": "integer"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object (for example, cost basis) in a structured format.",
"description": "Set of key-value pairs that you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.",
"type": "object"
},
"name": {
Expand Down Expand Up @@ -100395,7 +100395,7 @@
},
"/v1/billing/credit_grants/{id}": {
"get": {
"description": "<p>Retrieves a credit grant</p>",
"description": "<p>Retrieves a credit grant.</p>",
"operationId": "GetBillingCreditGrantsId",
"parameters": [
{
Expand Down Expand Up @@ -100463,7 +100463,7 @@
"summary": "Retrieve a credit grant"
},
"post": {
"description": "<p>Updates a credit grant</p>",
"description": "<p>Updates a credit grant.</p>",
"operationId": "PostBillingCreditGrantsId",
"parameters": [
{
Expand Down Expand Up @@ -100525,7 +100525,7 @@
"additionalProperties": {
"type": "string"
},
"description": "Set of key-value pairs you can attach to an object. This can be useful for storing additional information about the object (for example, cost basis) in a structured format.",
"description": "Set of key-value pairs you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.",
"type": "object"
}
},
Expand Down Expand Up @@ -101095,7 +101095,7 @@
},
"/v1/billing/meter_event_adjustments": {
"post": {
"description": "<p>Creates a billing meter event adjustment</p>",
"description": "<p>Creates a billing meter event adjustment.</p>",
"operationId": "PostBillingMeterEventAdjustments",
"requestBody": {
"content": {
Expand Down Expand Up @@ -101191,7 +101191,7 @@
},
"/v1/billing/meter_events": {
"post": {
"description": "<p>Creates a billing meter event</p>",
"description": "<p>Creates a billing meter event.</p>",
"operationId": "PostBillingMeterEvents",
"requestBody": {
"content": {
Expand Down Expand Up @@ -101223,7 +101223,7 @@
"type": "array"
},
"identifier": {
"description": "A unique identifier for the event. If not provided, one will be generated. We strongly advise using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations.",
"description": "A unique identifier for the event. If not provided, one is generated. We recommend using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations.",
"maxLength": 100,
"type": "string"
},
Expand Down Expand Up @@ -101428,7 +101428,7 @@
"summary": "List billing meters"
},
"post": {
"description": "<p>Creates a billing meter</p>",
"description": "<p>Creates a billing meter.</p>",
"operationId": "PostBillingMeters",
"requestBody": {
"content": {
Expand Down Expand Up @@ -101458,7 +101458,7 @@
"description": "Fields that specify how to map a meter event to a customer.",
"properties": {
"event_payload_key": {
"description": "The key in the usage event payload to use for mapping the event to a customer.",
"description": "The key in the meter event payload to use for mapping the event to a customer.",
"maxLength": 100,
"type": "string"
},
Expand Down Expand Up @@ -101503,7 +101503,7 @@
]
},
"display_name": {
"description": "The meter's name.",
"description": "The meter’s name. Not visible to the customer.",
"maxLength": 250,
"type": "string"
},
Expand Down Expand Up @@ -101593,7 +101593,7 @@
},
"/v1/billing/meters/{id}": {
"get": {
"description": "<p>Retrieves a billing meter given an ID</p>",
"description": "<p>Retrieves a billing meter given an ID.</p>",
"operationId": "GetBillingMetersId",
"parameters": [
{
Expand Down Expand Up @@ -101661,7 +101661,7 @@
"summary": "Retrieve a billing meter"
},
"post": {
"description": "<p>Updates a billing meter</p>",
"description": "<p>Updates a billing meter.</p>",
"operationId": "PostBillingMetersId",
"parameters": [
{
Expand Down Expand Up @@ -101689,7 +101689,7 @@
"additionalProperties": false,
"properties": {
"display_name": {
"description": "The meter's name.",
"description": "The meter’s name. Not visible to the customer.",
"maxLength": 250,
"type": "string"
},
Expand Down Expand Up @@ -101738,7 +101738,7 @@
},
"/v1/billing/meters/{id}/deactivate": {
"post": {
"description": "<p>Deactivates a billing meter</p>",
"description": "<p>When a meter is deactivated, no more meter events will be accepted for this meter. You can’t attach a deactivated meter to a price.</p>",
"operationId": "PostBillingMetersIdDeactivate",
"parameters": [
{
Expand Down Expand Up @@ -101998,7 +101998,7 @@
},
"/v1/billing/meters/{id}/reactivate": {
"post": {
"description": "<p>Reactivates a billing meter</p>",
"description": "<p>When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.</p>",
"operationId": "PostBillingMetersIdReactivate",
"parameters": [
{
Expand Down

0 comments on commit bf4a418

Please sign in to comment.