Payment

Add custom fields to payment

post/1.0/kb/payments/{paymentId}/customFields

Request

The document declares no server URL.
Auth
- HTTP basic
- or API key in header X-Killbill-ApiKey
- or API key in header X-Killbill-ApiSecret
TypeScript
https://skmtc.dev/killbill/apis/kill-bill/docs/1.0/kb/payments/:paymentId/customFields/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

paymentIdstring uuid required

Headers

X-Killbill-CreatedBystring required

X-Killbill-Reasonstring

X-Killbill-Commentstring

Request body

customFieldIdstring uuid

objectIdstring uuid

objectType'ACCOUNT' | 'ACCOUNT_EMAIL' | 'BLOCKING_STATES' | 'BUNDLE' | 'CUSTOM_FIELD' | 'INVOICE' | 'PAYMENT' | 'TRANSACTION' | 'INVOICE_ITEM' | 'INVOICE_PAYMENT' | 'SUBSCRIPTION' | 'SUBSCRIPTION_EVENT' | 'SERVICE_BROADCAST' | 'PAYMENT_ATTEMPT' | 'PAYMENT_METHOD' | 'TAG' | 'TAG_DEFINITION' | 'TENANT' | 'TENANT_KVS'

namestring required

valuestring required

Response

Custom field created successfully

customFieldIdstring uuid

objectIdstring uuid

objectType'ACCOUNT' | 'ACCOUNT_EMAIL' | 'BLOCKING_STATES' | 'BUNDLE' | 'CUSTOM_FIELD' | 'INVOICE' | 'PAYMENT' | 'TRANSACTION' | 'INVOICE_ITEM' | 'INVOICE_PAYMENT' | 'SUBSCRIPTION' | 'SUBSCRIPTION_EVENT' | 'SERVICE_BROADCAST' | 'PAYMENT_ATTEMPT' | 'PAYMENT_METHOD' | 'TAG' | 'TAG_DEFINITION' | 'TENANT' | 'TENANT_KVS'

namestring required

valuestring required

Changes

No recorded changes to this operation across all 4 revisions of this API.