Credit Note created.

Webhook for credit note creation.

Request Body

application/json

Details of the credit note when created.

TypeScript Definitions

Use the request body type in TypeScript.

idstringRequired

Unique identifier for the webhook event.

create_timestring<DateTimeWithZone>Required

Time when the webhook event was created.

Formatdate-time

event_versionstringOptional

Version of the event schema.

summarystringOptional

Brief description of the event.

resource_versionstringOptional

Version of the resource schema.

linksobject<Link>[]Optional

HATEOAS links for the webhook event.

resource_typeenum<ResourceType>Required

Type of resource that triggered the webhook.

event_typeenum<EventType>Required

Type of event that occurred in webhooks.

resourceobject<CreditNoteWithId>Required

CreditNoteWithId properties

22 properties

billing_entity_codestring<BillingEntityCode>Required

Unique code used to identify the billing entity. Must contain only alphanumeric characters, underscores, and hyphens.

Match^[a-zA-Z0-9_-]*$

sequential_idintegerRequired

The sequential identifier of the credit note, specifically scoped on the associated invoice. It provides a unique numerical identifier for the credit note within the context of the invoice.

numberstringRequired

The credit note unique number.

invoice_idstringRequired

Unique identifier assigned to the invoice that the credit note belongs to

Formatuuid

invoice_numberstringRequired

The invoice unique number, related to the credit note.

issuing_datestring<Date>Required

The date of creation of the credit note. It follows the ISO 8601 date format and provides the specific date when the credit note was created.

Match^(?:[1-9]\d{3}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|02-(?:0[1-9]|1\d|2[0-8]))|(?:(?:\d{2}(?:0[48]|[2468][048]|[13579][26]))|(?:[02468][048]00|[13579][26]00))-02-29)$Formatdate

credit_statusenum<CreditNoteStatus>Optional

The status of the credit portion of the credit note

Value in"AVAILABLE" | "CONSUMED" | "VOIDED"

refund_statusenum<RefundStatus>Optional

The status of the refund portion of the credit note

Value in"PENDING" | "SUCCEEDED" | "FAILED"

reasonenum<CreditNoteReason>Required

The reason for credit note creation

descriptionstring | nullOptional

The description of the credit note.

total_amountobject<Amount>Required

The total amount of the credit note.

taxes_amountobject<Amount>Required

The tax amount of the credit note.

taxes_ratenumberRequired

The tax rate associated with this specific credit note.

sub_total_excluding_taxes_amountobject<Amount>Required

The subtotal of the credit note excluding any applicable taxes.

balance_amountobject<Amount>Required

The remaining credit note amount.

credit_amountobject<Amount>Required

The credited amount of the credit note.

refund_amountobject<Amount>Required

The refunded amount of the credit note.

created_atstring<DateTimeWithZone>Required

The date when the credit note was created. It is expressed in Coordinated Universal Time (UTC).

Formatdate-time

updated_atstring<DateTimeWithZone>Required

The date when the credit note was last updated. It is expressed in Coordinated Universal Time (UTC).

Formatdate-time

itemsobject<CreditNoteItemObject>[]Optional

Array of credit note's items.

applied_taxesobject<CreditNoteAppliedTaxObject>[]Optional

idstringOptional

Response Body

Example Requests

POST/usage-billing.credit-note.created

Webhook for credit note creation.

Header Parameters

Request Body

application/json

Details of the credit note when created.

TypeScript Definitions

Use the request body type in TypeScript.

idstringRequired

Unique identifier for the webhook event.

create_timestring<DateTimeWithZone>Required

Time when the webhook event was created.

Formatdate-time

event_versionstringOptional

Version of the event schema.

summarystringOptional

Brief description of the event.

resource_versionstringOptional

Version of the resource schema.

linksobject<Link>[]Optional

HATEOAS links for the webhook event.

resource_typeenum<ResourceType>Required

Type of resource that triggered the webhook.

event_typeenum<EventType>Required

Type of event that occurred in webhooks.

resourceobject<CreditNoteWithId>Required

CreditNoteWithId properties

22 properties

billing_entity_codestring<BillingEntityCode>Required

Unique code used to identify the billing entity. Must contain only alphanumeric characters, underscores, and hyphens.

Match^[a-zA-Z0-9_-]*$

sequential_idintegerRequired

The sequential identifier of the credit note, specifically scoped on the associated invoice. It provides a unique numerical identifier for the credit note within the context of the invoice.

numberstringRequired

The credit note unique number.

invoice_idstringRequired

Unique identifier assigned to the invoice that the credit note belongs to

Formatuuid

invoice_numberstringRequired

The invoice unique number, related to the credit note.

issuing_datestring<Date>Required

The date of creation of the credit note. It follows the ISO 8601 date format and provides the specific date when the credit note was created.

credit_statusenum<CreditNoteStatus>Optional

The status of the credit portion of the credit note

Value in"AVAILABLE" | "CONSUMED" | "VOIDED"

refund_statusenum<RefundStatus>Optional

The status of the refund portion of the credit note

Value in"PENDING" | "SUCCEEDED" | "FAILED"

reasonenum<CreditNoteReason>Required

The reason for credit note creation

descriptionstring | nullOptional

The description of the credit note.

total_amountobject<Amount>Required

The total amount of the credit note.

taxes_amountobject<Amount>Required

The tax amount of the credit note.

taxes_ratenumberRequired

The tax rate associated with this specific credit note.

sub_total_excluding_taxes_amountobject<Amount>Required

The subtotal of the credit note excluding any applicable taxes.

balance_amountobject<Amount>Required

The remaining credit note amount.

credit_amountobject<Amount>Required

The credited amount of the credit note.

refund_amountobject<Amount>Required

The refunded amount of the credit note.

created_atstring<DateTimeWithZone>Required

The date when the credit note was created. It is expressed in Coordinated Universal Time (UTC).

Formatdate-time

updated_atstring<DateTimeWithZone>Required

The date when the credit note was last updated. It is expressed in Coordinated Universal Time (UTC).

Formatdate-time

itemsobject<CreditNoteItemObject>[]Optional

Array of credit note's items.

applied_taxesobject<CreditNoteAppliedTaxObject>[]Optional

idstringOptional

Response Body

Example Requests

POST/usage-billing.credit-note.created

Header Parameters

Request Body

Link properties

CreditNoteWithId properties

Amount properties

Amount properties

Amount properties

Amount properties

Amount properties

Amount properties

CreditNoteItemObject properties

Amount properties

FeeObject properties

Amount properties

CreditNoteAppliedTaxObject properties

Amount properties

Amount properties

Response Body

204

Request Bodyapplication/json

Header Parameters

On this page

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Credit Note created.

Header Parameters

Request Body

Link properties

CreditNoteWithId properties

Amount properties

Amount properties

Amount properties

Amount properties

Amount properties

Amount properties

CreditNoteItemObject properties

Amount properties

FeeObject properties

Amount properties

CreditNoteAppliedTaxObject properties

Amount properties

Amount properties

Response Body

204

Request Bodyapplication/json

Header Parameters

On this page

On this page