Skip to content

Commit

Permalink
Update OpenAPI specification
Browse files Browse the repository at this point in the history
  • Loading branch information
@stripe-openapi
stripe-openapi[bot] committed Jul 29, 2024
1 parent e3f1d43 commit 8daa8c2
Show file tree
Hide file tree
Showing 4 changed files with 411 additions and 0 deletions.
2 changes: 2 additions & 0 deletions openapi/spec3.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -163213,6 +163213,7 @@
"application_fee.refund.updated",
"application_fee.refunded",
"balance.available",
"billing.alert.triggered",
"billing_portal.configuration.created",
"billing_portal.configuration.updated",
"billing_portal.session.created",
Expand Down Expand Up @@ -163700,6 +163701,7 @@
"application_fee.refund.updated",
"application_fee.refunded",
"balance.available",
"billing.alert.triggered",
"billing_portal.configuration.created",
"billing_portal.configuration.updated",
"billing_portal.session.created",
Expand Down
229 changes: 229 additions & 0 deletions openapi/spec3.sdk.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3937,6 +3937,153 @@
"type": "object",
"x-expandableFields": []
},
"billing.alert": {
"description": "A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.",
"properties": {
"alert_type": {
"description": "Defines the type of the alert.",
"enum": [
"usage_threshold"
],
"type": "string"
},
"filter": {
"anyOf": [
{
"$ref": "#/components/schemas/thresholds_resource_alert_filter"
}
],
"description": "Limits the scope of the alert to a specific [customer](https://stripe.com/docs/api/customers).",
"nullable": true
},
"id": {
"description": "Unique identifier for the object.",
"maxLength": 5000,
"type": "string"
},
"livemode": {
"description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
"type": "boolean"
},
"object": {
"description": "String representing the object's type. Objects of the same type share the same value.",
"enum": [
"billing.alert"
],
"type": "string"
},
"status": {
"description": "Status of the alert. This can be active, inactive or archived.",
"enum": [
"active",
"archived",
"inactive"
],
"nullable": true,
"type": "string"
},
"title": {
"description": "Title of the alert.",
"maxLength": 5000,
"type": "string"
},
"usage_threshold_config": {
"anyOf": [
{
"$ref": "#/components/schemas/thresholds_resource_usage_threshold_config"
}
],
"description": "Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter).",
"nullable": true
}
},
"required": [
"alert_type",
"filter",
"id",
"livemode",
"object",
"status",
"title",
"usage_threshold_config"
],
"title": "ThresholdsResourceAlert",
"type": "object",
"x-expandableFields": [
"filter",
"usage_threshold_config"
],
"x-stripeResource": {
"class_name": "Alert",
"in_package": "Billing"
}
},
"billing.alert.triggered": {
"description": "Occurs whenever your custom alert threshold is met.",
"properties": {
"object": {
"$ref": "#/components/schemas/billing.alert_triggered"
}
},
"required": [
"object"
],
"type": "object",
"x-expandableFields": [],
"x-stripeEvent": {
"type": "billing.alert.triggered"
}
},
"billing.alert_triggered": {
"description": "",
"properties": {
"alert": {
"$ref": "#/components/schemas/billing.alert"
},
"created": {
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
"format": "unix-time",
"type": "integer"
},
"customer": {
"description": "ID of customer for which the alert triggered",
"maxLength": 5000,
"type": "string"
},
"livemode": {
"description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
"type": "boolean"
},
"object": {
"description": "String representing the object's type. Objects of the same type share the same value.",
"enum": [
"billing.alert_triggered"
],
"type": "string"
},
"value": {
"description": "The value triggering the alert",
"type": "integer"
}
},
"required": [
"alert",
"created",
"customer",
"livemode",
"object",
"value"
],
"title": "ThresholdsResourceAlert",
"type": "object",
"x-expandableFields": [
"alert"
],
"x-stripeResource": {
"class_name": "AlertTriggered",
"in_package": "Billing"
}
},
"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.",
"properties": {
Expand Down Expand Up @@ -14929,6 +15076,7 @@
"application_fee.refund.updated",
"application_fee.refunded",
"balance.available",
"billing.alert.triggered",
"billing_portal.configuration.created",
"billing_portal.configuration.updated",
"billing_portal.session.created",
Expand Down Expand Up @@ -57653,6 +57801,85 @@
"type": "object",
"x-expandableFields": []
},
"thresholds_resource_alert_filter": {
"description": "",
"properties": {
"customer": {
"anyOf": [
{
"maxLength": 5000,
"type": "string"
},
{
"$ref": "#/components/schemas/customer"
}
],
"description": "Limit the scope of the alert to this customer ID",
"nullable": true,
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/customer"
}
]
}
}
},
"required": [
"customer"
],
"title": "ThresholdsResourceAlertFilter",
"type": "object",
"x-expandableFields": [
"customer"
]
},
"thresholds_resource_usage_threshold_config": {
"description": "The usage threshold alert configuration enables setting up alerts for when a certain usage threshold on a specific meter is crossed.",
"properties": {
"gte": {
"description": "The value at which this alert will trigger.",
"type": "integer"
},
"meter": {
"anyOf": [
{
"maxLength": 5000,
"type": "string"
},
{
"$ref": "#/components/schemas/billing.meter"
}
],
"description": "The [Billing Meter](/api/billing/meter) ID whose usage is monitored.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/billing.meter"
}
]
}
},
"recurrence": {
"description": "Defines how the alert will behave.",
"enum": [
"one_time"
],
"type": "string",
"x-stripeBypassValidation": true
}
},
"required": [
"gte",
"meter",
"recurrence"
],
"title": "ThresholdsResourceUsageThresholdConfig",
"type": "object",
"x-expandableFields": [
"meter"
]
},
"token": {
"description": "Tokenization is the process Stripe uses to collect sensitive card or bank\naccount details, or personally identifiable information (PII), directly from\nyour customers in a secure manner. A token representing this information is\nreturned to your server to use. Use our\n[recommended payments integrations](https://stripe.com/docs/payments) to perform this process\non the client-side. This guarantees that no sensitive card data touches your server,\nand allows your integration to operate in a PCI-compliant way.\n\nIf you can't use client-side tokenization, you can also create tokens using\nthe API with either your publishable or secret API key. If\nyour integration uses this method, you're responsible for any PCI compliance\nthat it might require, and you must keep your secret API key safe. Unlike with\nclient-side tokenization, your customer's information isn't sent directly to\nStripe, so we can't determine how it's handled or stored.\n\nYou can't store or use tokens more than once. To store card or bank account\ninformation for later use, create [Customer](https://stripe.com/docs/api#customers)\nobjects or [External accounts](/api#external_accounts).\n[Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection,\nperforms best with integrations that use client-side tokenization.",
"properties": {
Expand Down Expand Up @@ -172243,6 +172470,7 @@
"application_fee.refund.updated",
"application_fee.refunded",
"balance.available",
"billing.alert.triggered",
"billing_portal.configuration.created",
"billing_portal.configuration.updated",
"billing_portal.session.created",
Expand Down Expand Up @@ -172730,6 +172958,7 @@
"application_fee.refund.updated",
"application_fee.refunded",
"balance.available",
"billing.alert.triggered",
"billing_portal.configuration.created",
"billing_portal.configuration.updated",
"billing_portal.session.created",
Expand Down
Loading

0 comments on commit 8daa8c2

Please sign in to comment.