get: operationId: GetPaymentCollectionsPaymentCollection summary: Get a PaymentCollection description: Retrieves a PaymentCollection. x-authenticated: true parameters: - in: path name: id required: true description: The ID of the PaymentCollection. schema: type: string - in: query name: expand description: Comma separated list of relations to include in the results. schema: type: string - in: query name: fields description: Comma separated list of fields to include in the results. schema: type: string x-codegen: method: retrieve queryParams: AdminGetPaymentCollectionsParams x-codeSamples: - lang: JavaScript label: JS Client source: $ref: ../code_samples/JavaScript/admin_payment-collections_{id}/get.js - lang: Shell label: cURL source: $ref: ../code_samples/Shell/admin_payment-collections_{id}/get.sh security: - api_token: [] - cookie_auth: [] tags: - Payment Collections responses: '200': description: OK content: application/json: schema: $ref: ../components/schemas/AdminPaymentCollectionsRes.yaml '400': $ref: ../components/responses/400_error.yaml '401': $ref: ../components/responses/unauthorized.yaml '404': $ref: ../components/responses/not_found_error.yaml '409': $ref: ../components/responses/invalid_state_error.yaml '422': $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml post: operationId: PostPaymentCollectionsPaymentCollection summary: Update PaymentCollection description: Updates a PaymentCollection. x-authenticated: true parameters: - in: path name: id required: true description: The ID of the PaymentCollection. schema: type: string requestBody: content: application/json: schema: $ref: ../components/schemas/AdminUpdatePaymentCollectionsReq.yaml x-codegen: method: update x-codeSamples: - lang: JavaScript label: JS Client source: $ref: ../code_samples/JavaScript/admin_payment-collections_{id}/post.js - lang: Shell label: cURL source: $ref: ../code_samples/Shell/admin_payment-collections_{id}/post.sh security: - api_token: [] - cookie_auth: [] tags: - Payment Collections responses: '200': description: OK content: application/json: schema: $ref: ../components/schemas/AdminPaymentCollectionsRes.yaml '400': $ref: ../components/responses/400_error.yaml '401': $ref: ../components/responses/unauthorized.yaml '404': $ref: ../components/responses/not_found_error.yaml '409': $ref: ../components/responses/invalid_state_error.yaml '422': $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml delete: operationId: DeletePaymentCollectionsPaymentCollection summary: Del a PaymentCollection description: Deletes a Payment Collection x-authenticated: true parameters: - in: path name: id required: true description: The ID of the Payment Collection to delete. schema: type: string x-codegen: method: delete x-codeSamples: - lang: JavaScript label: JS Client source: $ref: ../code_samples/JavaScript/admin_payment-collections_{id}/delete.js - lang: Shell label: cURL source: $ref: ../code_samples/Shell/admin_payment-collections_{id}/delete.sh security: - api_token: [] - cookie_auth: [] tags: - Payment Collections responses: '200': description: OK content: application/json: schema: $ref: ../components/schemas/AdminPaymentCollectionDeleteRes.yaml '400': $ref: ../components/responses/400_error.yaml '401': $ref: ../components/responses/unauthorized.yaml