Skip to content

Commit

Permalink
Update OpenAPI specification
Browse files Browse the repository at this point in the history
  • Loading branch information
stripe-openapi[bot] committed Aug 29, 2024
1 parent ab2ec8e commit 75cb9d9
Show file tree
Hide file tree
Showing 2 changed files with 360 additions and 0 deletions.
204 changes: 204 additions & 0 deletions openapi/spec3.sdk.json
Original file line number Diff line number Diff line change
Expand Up @@ -4275,6 +4275,117 @@
"in_package": "Billing"
}
},
"billing.meter_error_related_object": {
"description": "",
"properties": {
"id": {
"description": "Unique identifier for the object.",
"maxLength": 100,
"type": "string"
},
"object": {
"description": "The type of meter error related object. Should be 'meter'",
"maxLength": 5000,
"type": "string"
},
"url": {
"description": "The url of the meter object",
"maxLength": 5000,
"type": "string"
}
},
"required": [
"id",
"object",
"url"
],
"title": "BillingMeterResourceRelatedObject",
"type": "object",
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "MeterErrorRelatedObject",
"in_package": "Billing"
}
},
"billing.meter_error_report": {
"description": "",
"properties": {
"id": {
"description": "Unique identifier for the object.",
"maxLength": 5000,
"type": "string"
},
"object": {
"description": "String representing the object's type. Objects of the same type share the same value.",
"enum": [
"billing.meter_error_report"
],
"type": "string"
},
"reason": {
"$ref": "#/components/schemas/billing_meter_resource_meter_error_reason"
},
"related_object": {
"anyOf": [
{
"$ref": "#/components/schemas/billing.meter_error_related_object"
}
],
"description": "The related objects about the error",
"nullable": true
},
"summary": {
"description": "Summary of invalid events",
"maxLength": 5000,
"type": "string"
},
"validation_end": {
"description": "Time when validation ended. Measured in seconds since the Unix epoch",
"format": "unix-time",
"type": "integer"
},
"validation_start": {
"description": "Time when validation started. Measured in seconds since the Unix epoch",
"format": "unix-time",
"type": "integer"
}
},
"required": [
"id",
"object",
"reason",
"related_object",
"summary",
"validation_end",
"validation_start"
],
"title": "BillingMeterResourceMeterErrorReportNotification",
"type": "object",
"x-expandableFields": [
"reason",
"related_object"
],
"x-stripeResource": {
"class_name": "MeterErrorReport",
"in_package": "Billing"
}
},
"billing.meter_error_report.triggered": {
"description": "Notifies of errors on a billing meter",
"properties": {
"object": {
"$ref": "#/components/schemas/billing.meter_error_report"
}
},
"required": [
"object"
],
"type": "object",
"x-expandableFields": [],
"x-stripeEvent": {
"type": "billing.meter_error_report.triggered"
}
},
"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.",
"properties": {
Expand Down Expand Up @@ -4649,6 +4760,99 @@
"type": "object",
"x-expandableFields": []
},
"billing_meter_resource_meter_error_reason": {
"description": "",
"properties": {
"error_count": {
"description": "The number of errors generated",
"type": "integer"
},
"error_types": {
"description": "More information about errors",
"items": {
"$ref": "#/components/schemas/billing_meter_resource_meter_error_reason_error_type"
},
"type": "array"
}
},
"required": [
"error_count",
"error_types"
],
"title": "BillingMeterResourceMeterErrorReason",
"type": "object",
"x-expandableFields": [
"error_types"
]
},
"billing_meter_resource_meter_error_reason_error_type": {
"description": "",
"properties": {
"sample_errors": {
"items": {
"$ref": "#/components/schemas/billing_meter_resource_meter_error_reason_sample_error"
},
"type": "array"
}
},
"required": [
"sample_errors"
],
"title": "BillingMeterResourceMeterErrorReasonErrorType",
"type": "object",
"x-expandableFields": [
"sample_errors"
]
},
"billing_meter_resource_meter_error_reason_sample_error": {
"description": "",
"properties": {
"api_request": {
"anyOf": [
{
"$ref": "#/components/schemas/billing_meter_resource_meter_error_reason_sample_error_request"
}
],
"nullable": true
},
"error_message": {
"description": "message of the error",
"maxLength": 5000,
"type": "string"
}
},
"required": [
"api_request",
"error_message"
],
"title": "BillingMeterResourceMeterErrorReasonSampleError",
"type": "object",
"x-expandableFields": [
"api_request"
]
},
"billing_meter_resource_meter_error_reason_sample_error_request": {
"description": "",
"properties": {
"id": {
"description": "Unique identifier for the object.",
"maxLength": 5000,
"type": "string"
},
"idempotency_key": {
"description": "idempotency_key of the request",
"maxLength": 5000,
"type": "string"
}
},
"required": [
"id",
"idempotency_key"
],
"title": "BillingMeterResourceMeterErrorReasonSampleErrorRequest",
"type": "object",
"x-expandableFields": []
},
"billing_portal.configuration": {
"description": "A portal configuration describes the functionality and behavior of a portal session.",
"properties": {
Expand Down
156 changes: 156 additions & 0 deletions openapi/spec3.sdk.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4067,6 +4067,93 @@ components:
class_name: Meter
has_collection_class: true
in_package: Billing
billing.meter_error_related_object:
description: ''
properties:
id:
description: Unique identifier for the object.
maxLength: 100
type: string
object:
description: The type of meter error related object. Should be 'meter'
maxLength: 5000
type: string
url:
description: The url of the meter object
maxLength: 5000
type: string
required:
- id
- object
- url
title: BillingMeterResourceRelatedObject
type: object
x-expandableFields: []
x-stripeResource:
class_name: MeterErrorRelatedObject
in_package: Billing
billing.meter_error_report:
description: ''
properties:
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: >-
String representing the object's type. Objects of the same type
share the same value.
enum:
- billing.meter_error_report
type: string
reason:
$ref: '#/components/schemas/billing_meter_resource_meter_error_reason'
related_object:
anyOf:
- $ref: '#/components/schemas/billing.meter_error_related_object'
description: The related objects about the error
nullable: true
summary:
description: Summary of invalid events
maxLength: 5000
type: string
validation_end:
description: Time when validation ended. Measured in seconds since the Unix epoch
format: unix-time
type: integer
validation_start:
description: >-
Time when validation started. Measured in seconds since the Unix
epoch
format: unix-time
type: integer
required:
- id
- object
- reason
- related_object
- summary
- validation_end
- validation_start
title: BillingMeterResourceMeterErrorReportNotification
type: object
x-expandableFields:
- reason
- related_object
x-stripeResource:
class_name: MeterErrorReport
in_package: Billing
billing.meter_error_report.triggered:
description: Notifies of errors on a billing meter
properties:
object:
$ref: '#/components/schemas/billing.meter_error_report'
required:
- object
type: object
x-expandableFields: []
x-stripeEvent:
type: billing.meter_error_report.triggered
billing.meter_event:
description: >-
A billing meter event represents a customer's usage of a product. Meter
Expand Down Expand Up @@ -4404,6 +4491,75 @@ components:
title: BillingMeterResourceCustomerMappingSettings
type: object
x-expandableFields: []
billing_meter_resource_meter_error_reason:
description: ''
properties:
error_count:
description: The number of errors generated
type: integer
error_types:
description: More information about errors
items:
$ref: >-
#/components/schemas/billing_meter_resource_meter_error_reason_error_type
type: array
required:
- error_count
- error_types
title: BillingMeterResourceMeterErrorReason
type: object
x-expandableFields:
- error_types
billing_meter_resource_meter_error_reason_error_type:
description: ''
properties:
sample_errors:
items:
$ref: >-
#/components/schemas/billing_meter_resource_meter_error_reason_sample_error
type: array
required:
- sample_errors
title: BillingMeterResourceMeterErrorReasonErrorType
type: object
x-expandableFields:
- sample_errors
billing_meter_resource_meter_error_reason_sample_error:
description: ''
properties:
api_request:
anyOf:
- $ref: >-
#/components/schemas/billing_meter_resource_meter_error_reason_sample_error_request
nullable: true
error_message:
description: message of the error
maxLength: 5000
type: string
required:
- api_request
- error_message
title: BillingMeterResourceMeterErrorReasonSampleError
type: object
x-expandableFields:
- api_request
billing_meter_resource_meter_error_reason_sample_error_request:
description: ''
properties:
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
idempotency_key:
description: idempotency_key of the request
maxLength: 5000
type: string
required:
- id
- idempotency_key
title: BillingMeterResourceMeterErrorReasonSampleErrorRequest
type: object
x-expandableFields: []
billing_portal.configuration:
description: >-
A portal configuration describes the functionality and behavior of a
Expand Down

0 comments on commit 75cb9d9

Please sign in to comment.