openapi/api.yaml in recurly-4.29.0 vs openapi/api.yaml in recurly-4.30.0

- old
+ new

@@ -226,12 +226,12 @@ tags: - name: site x-displayName: Site - name: custom_field_definition x-displayName: Custom Field Definition - description: Describes the fields that can use used as custom fields on accounts - or subscriptions. + description: Describes the fields that can be used as custom fields on accounts, + items, line-items (one time charges), plans, or subscriptions. - name: item x-displayName: Item description: |- For merchants who sell the same things to many customers, documenting those offerings in a catalog allows for faster charge creation, easier management of offerings, and analytics about your offerings across all sales channels. Because your offerings can be physical, digital, or service-oriented, Recurly collectively calls these offerings "Items". @@ -18209,10 +18209,11 @@ The access control applied inside Recurly's admin UI: - `api_only` - No one will be able to view or edit this field's data via the admin UI. - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but editing will only be available via the API. - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI. + - `set_only` - Users with the Customers role will be able to set this field's data via the admin console. "$ref": "#/components/schemas/UserAccessEnum" display_name: type: string title: Display name description: Used to label the field when viewing and editing the field @@ -22844,14 +22845,17 @@ object: type: string title: Object type account: "$ref": "#/components/schemas/AccountMini" - external_resource: - "$ref": "#/components/schemas/ExternalResourceMini" external_product_reference: "$ref": "#/components/schemas/ExternalProductReferenceMini" + external_id: + type: string + title: External Id + description: The id of the subscription in the external systems., I.e. Apple + App Store or Google Play Store. last_purchased: type: string format: date-time title: Last purchased description: When a new billing event occurred on the external subscription @@ -22870,10 +22874,14 @@ type: integer title: Quantity description: An indication of the quantity of a subscribed item's quantity. default: 1 minimum: 0 + state: + type: string + description: External subscriptions can be active, canceled, expired, or + future. activated_at: type: string format: date-time title: Activated at description: When the external subscription was activated in the external @@ -22908,29 +22916,10 @@ description: Path to subsequent page of results. data: type: array items: "$ref": "#/components/schemas/ExternalSubscription" - ExternalResourceMini: - type: object - title: External Resource mini details - properties: - id: - type: string - title: External resource ID - description: System-generated unique identifier for an external resource - ID, e.g. `e28zov4fw0v2`. - object: - type: string - title: Object type - external_object_reference: - type: string - title: External Object Reference - description: Identifier or URL reference where the resource is canonically - available in the external platform. - maxLength: 255 - readOnly: true CustomerPermission: type: object properties: id: type: string @@ -23671,9 +23660,10 @@ type: string enum: - api_only - read_only - write + - set_only PricingModelTypeEnum: type: string enum: - fixed - ramp