> ## Documentation Index > Fetch the complete documentation index at: https://docs.meteroid.com/llms.txt > Use this file to discover all available pages before exploring further. # Update credit note custom properties > Merge custom property values onto a credit note (send a key with `null` to remove it). Values are validated against the tenant's `CREDIT_NOTE` property definitions. Allowed at any status — custom properties are external workflow metadata and stay editable after the credit note is finalized. ## OpenAPI ````yaml https://api.meteroid.com/api-docs/openapi.json patch /api/v1/credit-notes/{credit_note_id}/custom-properties openapi: 3.1.0 info: title: meteroid description: '' license: name: LicenseRef-Proprietary identifier: LicenseRef-Proprietary version: 0.1.0 servers: [] security: [] tags: - name: Meteroid description: Meteroid API - name: Add-ons - name: Batch Jobs - name: Checkout Sessions - name: Connect description: Manage connected accounts (Express & Standard) - name: Coupons - name: Credit Notes - name: Custom Properties - name: Customers - name: Entitlements - name: Events - name: Features - name: Invoices - name: Metrics - name: OAuth description: OAuth 2.0 token endpoints (public, client-credentials auth) - name: OAuth Apps description: Manage OAuth applications for Connect integrations - name: Plans - name: Product Families - name: Products - name: Subscriptions - name: Usage paths: /api/v1/credit-notes/{credit_note_id}/custom-properties: patch: tags: - Credit Notes summary: Update credit note custom properties description: >- Merge custom property values onto a credit note (send a key with `null` to remove it). Values are validated against the tenant's `CREDIT_NOTE` property definitions. Allowed at any status — custom properties are external workflow metadata and stay editable after the credit note is finalized. operationId: patch_credit_note_custom_properties parameters: - name: credit_note_id in: path description: Credit Note ID required: true schema: $ref: '#/components/schemas/CreditNoteId' example: cn_123 requestBody: content: application/json: schema: $ref: '#/components/schemas/CreditNoteCustomPropertiesRequest' required: true responses: '200': description: Updated credit note content: application/json: schema: $ref: '#/components/schemas/CreditNote' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/RestErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/RestErrorResponse' '404': description: Credit note not found content: application/json: schema: $ref: '#/components/schemas/RestErrorResponse' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/RestErrorResponse' '500': description: Internal error content: application/json: schema: $ref: '#/components/schemas/RestErrorResponse' security: - bearer_auth: [] components: schemas: CreditNoteId: type: string format: MeteroidId examples: - crn_7n42DGM5Tflk9n8mt7Fhc7 CreditNoteCustomPropertiesRequest: type: object description: >- Merge update of a credit note's custom property values (send a key with `null` to remove it). Allowed at any status — custom properties stay editable after the credit note is finalized. required: - custom_properties properties: custom_properties: {} CreditNote: type: object required: - id - credit_note_number - status - credit_type - customer_id - invoice_id - invoice_number - currency - subtotal - tax_amount - total - refunded_amount_cents - credited_amount_cents - line_items - tax_breakdown - created_at - custom_properties properties: created_at: type: string format: date-time credit_note_number: type: string credit_type: $ref: '#/components/schemas/CreditType' credited_amount_cents: type: integer format: int64 currency: $ref: '#/components/schemas/Currency' custom_properties: description: User-defined custom property values, keyed by definition `key`. customer_id: $ref: '#/components/schemas/CustomerId' finalized_at: type: - string - 'null' format: date-time id: $ref: '#/components/schemas/CreditNoteId' invoice_id: $ref: '#/components/schemas/InvoiceId' invoice_number: type: string line_items: type: array items: $ref: '#/components/schemas/InvoiceLineItem' memo: type: - string - 'null' plan_version_id: oneOf: - $ref: '#/components/schemas/PlanVersionId' - type: 'null' reason: type: - string - 'null' refunded_amount_cents: type: integer format: int64 status: $ref: '#/components/schemas/CreditNoteStatus' subscription_id: oneOf: - $ref: '#/components/schemas/SubscriptionId' - type: 'null' subtotal: type: integer format: int64 tax_amount: type: integer format: int64 tax_breakdown: type: array items: $ref: '#/components/schemas/TaxBreakdownItem' total: type: integer format: int64 updated_at: type: - string - 'null' format: date-time voided_at: type: - string - 'null' format: date-time RestErrorResponse: type: object required: - code - message properties: code: $ref: '#/components/schemas/ErrorCode' message: type: string CreditType: type: string title: CreditType enum: - CREDIT_TO_BALANCE - REFUND - DEBT_CANCELLATION Currency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNH - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STD - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL examples: - EUR CustomerId: type: string format: MeteroidId examples: - cus_7n42DGM5Tflk9n8mt7Fhc7 InvoiceId: type: string format: MeteroidId examples: - inv_7n42DGM5Tflk9n8mt7Fhc7 InvoiceLineItem: type: object required: - name - amount_total - start_date - end_date - tax_rate - sub_line_items properties: amount_total: type: integer format: int64 description: type: - string - 'null' end_date: type: string format: date name: type: string quantity: type: string format: decimal start_date: type: string format: date sub_line_items: type: array items: $ref: '#/components/schemas/SubLineItem' tax_rate: type: string format: decimal unit_price: type: string format: decimal PlanVersionId: type: string format: MeteroidId examples: - plv_7n42DGM5Tflk9n8mt7Fhc7 CreditNoteStatus: type: string enum: - DRAFT - FINALIZED - VOIDED SubscriptionId: type: string format: MeteroidId examples: - sub_7n42DGM5Tflk9n8mt7Fhc7 TaxBreakdownItem: type: object required: - taxable_amount - tax_amount - tax_rate - name properties: exemption_type: oneOf: - $ref: '#/components/schemas/TaxExemptionType' - type: 'null' name: type: string tax_amount: type: integer format: int64 minimum: 0 tax_rate: type: string format: decimal taxable_amount: type: integer format: int64 minimum: 0 ErrorCode: type: string enum: - BAD_REQUEST - NOT_FOUND - CONFLICT - FORBIDDEN - UNAUTHORIZED - TOO_MANY_REQUESTS - INTERNAL_SERVER_ERROR SubLineItem: type: object required: - id - name - total - quantity - unit_price properties: id: type: string name: type: string quantity: type: string format: decimal total: type: integer format: int64 unit_price: type: string format: decimal TaxExemptionType: type: string enum: - REVERSE_CHARGE - TAX_EXEMPT - NOT_REGISTERED securitySchemes: bearer_auth: type: http scheme: bearer ````