Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuora Attachments API

Use attachments in Zuora to upload documents of various formats to associate additional information with accounts, subscriptions, invoices, credit memos, or debit memos. Example attachments could be purchase orders (PO's), tax exemption document, or ownership transfer forms.For more information about attachments, see Attachments.

Zuora Attachments API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Attachments. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

5 operations 3 paths 6 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2023-12-15
Resource Areas
1

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Attachments 5

Use attachments in Zuora to upload documents of various formats to associate additional information with accounts, subscriptions, invoices, credit memos, or debit memos. Example a…

POST
/v1/attachments
Create an attachment
POST_Attachments 11 params → 200
GET
/v1/attachments/{object-type}/{object-key}
List attachments by object type and key
GET_AttachmentsList 10 params → 200
GET
/v1/attachments/{attachment-id}
Retrieve an attachment
GET_Attachments 7 params → 200
PUT
/v1/attachments/{attachment-id}
Update an attachment
PUT_Attachments 8 params → 200
DELETE
/v1/attachments/{attachment-id}
Delete an attachment
DELETE_Attachments 7 params → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are GETAttachmentResponseType (11 properties), GETAttachmentResponseWithoutSuccessType (10 properties), POSTAttachmentResponseType (3 properties), CommonResponseType (3 properties). Each schema is shown below with its type and property counts.

GETAttachmentsResponseType
object
3 properties
CommonResponseType
object
3 properties
GETAttachmentResponseWithoutSuccessType
object
10 properties
GETAttachmentResponseType
object
11 properties
PUTAttachmentType
object
2 properties
POSTAttachmentResponseType
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-attachments-api-openapi.yml Raw ↑

Other APIs Zuora publishes across the network.

Zuora V1 API
Zuora Accounting Codes API
Zuora Accounting Periods API
Zuora Accounts API
Zuora Actions API
Zuora Aggregate Queries API
Zuora API Health API
Zuora Bill Run API
Zuora Bill Run Health API
Zuora Billing Documents API
Zuora Billing Preview Run API
Zuora Catalog API