Get an invoice

get https://api.copperx.dev/api/v1/invoices/{id}

Returns an invoice

Responses

Response body

object

string

required

createdAt

date-time

updatedAt

date-time

organizationId

uuid

required

description

string

total

int64

subTotal

int64

currency

string

usdc usdt pyusd eurc brett dai btc eth matic bnb sol busd trx food bonk wif goat spx truf pengu

customerId

uuid

required

customer

object

required

name

string

The name

string

The email

phone

string

The phone

organizationName

string

The organization name

address

object

The address

uuid

required

Customer's id

createdAt

date-time

Customer's created at

updatedAt

date-time

Customer's updated at

customerReferenceId

string

Customer's reference id

shipping

object

Customer's shipping address

taxIds

object

visibility

string

Customer's visibility. If Dashboard then displayed on dashboard UI. If API then only returned in API response only.

10 20

metadata

object

Customer's metadata

Has additional fields

customerNumber

string

required

Customer number assigned by the system

autoAdvance

boolean

required

collectionMethod

string

required

charge_automatically send_invoice

invoiceType

string

one_time recurring

customFields

object

fields

array of objects

fields

object

name

string

required

value

string

required

paymentSettingId

uuid

required

paymentSetting

object

required

string

required

createdAt

date-time

updatedAt

date-time

paymentMethodTypes

array of strings

length between 1 and 1

A list of the types of payment methods

paymentMethodTypes

allowedChains

array of objects

The list of chains allowed for the payment. If not provided, all chains supported by the organization are enabled.

allowedChains

object

chainId

number

required

blacklistCurrencies

array of strings

The list of currencies to disable for the payment. Note: This field is only used for checkout session API atm.

blacklistCurrencies

withdrawalAddress

string

This is optional, default withdrawal address configured in dashboard under settings > payment methods is used. The custom withdrawal address to use for this chain instead of stored default withdrawal address.

withdrawalAddresses

array of objects

length between 2 and 4

The list of withdrawal addresses to split the payment. If provided, the sum of all split percentages should be 100.

withdrawalAddresses

object

splitPercentage

number

required

0 to 100

address

string

required

The withdrawal address for the split percentage

allowedCurrencies

array of strings

The list of currencies allowed for the payment.

allowedCurrencies

preferredChainId

number

The preferred chain's id

preferredCurrency

string

The preferred currency for payment

usdc usdt pyusd eurc brett dai btc eth matic bnb sol busd trx food bonk wif goat spx truf pengu

allowSwap

boolean

Defaults to false

Whether the user can swap the payment currency

applyFee

boolean

Defaults to false

Whether add a application fee to the user payment

feePercentage

number

required

0 to 100

Percent that will be added to subtotal as a fee

applyGasFee

boolean

Defaults to false

Whether add a transaction fee to the user payment

allowSplitPayments

boolean

Whether the user can split the payment

slippagePercentage

number

0 to 100

Defaults to 10

The slippage percentage allowed for swaps and withdrawals

status

string

required

draft open paid void uncollectible

attempted

boolean

required

attemptCount

number

nextPaymentAttempt

date-time

dueDate

date-time

footer

string

fromInvoiceId

uuid

latestRevisionId

uuid

invoicePdfUrl

string

invoiceNumber

string

paid

boolean

required

paidOutOfBand

boolean

metadata

object

Has additional fields

clientReferenceId

string

lineItems

object

required

object

string

data

array of objects

data

object

description

string

periodStart

date-time

periodEnd

date-time

quantity

number

price

object

required

taxRates

array of objects

taxRates

object

string

required

name

string

required

The name of the tax rate.

description

string

The description of the tax rate.

country

string

The country of the tax rate.

percentage

number

required

0 to 100

Percent that will be added to subtotal as a tax.

type

string

required

The type of the tax rate.

exclusive inclusive

isDefault

boolean

required

amountTotal

int64

amountSubtotal

int64

amountTax

int64

currency

string

usdc usdt pyusd eurc brett dai btc eth matic bnb sol busd trx food bonk wif goat spx truf pengu usd inr

finalizedAt

date-time

paidAt

date-time

markedUncollectibleAt

date-time

visibility

string

10 20

paymentIntentId

uuid

url

string

required

The URL to redirect the customer to pay invoice

subscriptionId

string

periodStart

date-time

periodEnd

date-time

billingReason

string

required

subscription_cycle subscription_create subscription_update subscription manual upcoming subscription_threshold

allowPromotionCodes

boolean

Enables user redeemable promotion codes.

finalizeScheduleAt

date-time

The date on which invoice will be finalize and send

totalTax

int64

paymentIntent

object

string

required

createdAt

date-time

updatedAt

date-time

organizationId

uuid

required

amount

int64

amountReceived

int64

currency

string

usdc usdt pyusd eurc brett dai btc eth matic bnb sol busd trx food bonk wif goat spx truf pengu usd inr

status

string

required

requires_payment_method requires_confirmation requires_action processing requires_capture canceled succeeded

paymentMethodId

uuid

required

description

string

paymentMethod

object

paymentMethodTypes

array of strings

paymentMethodTypes

transferAccountAddress

string

transactions

array of objects

required

transactions*

object

type

string

required

Transaction type

incoming outgoing event transfer

transactionRelayId

string

Transaction relay id

transactionHash

string

Transaction hash

nonce

number

Transaction nonce

gasLimit

number

Transaction gas limit used in payment

validUntil

string

Transaction valid until

fromAddress

string

required

Transaction from address

toAddress

string

required

Transaction to address

currency

string

required

Transaction currency

usdc usdt pyusd eurc brett dai btc eth matic bnb sol busd trx food bonk wif goat spx truf pengu usd inr

createdAt

date-time

Transaction created at

amount

int64

Transaction amount in 8 decimals

amountRaw

string

required

Transaction amount raw received from alchemy

assetId

string

required

Transaction asset id

asset

object

required

transactionUrl

string

Transaction url

paymentReceipt

object

canceledAt

date-time

cancellationReason

string

stripe

object

isMarkRefunded

boolean | null

markRefundedAt

date-time | null

markRefundedComment

string | null

paymentIntentAttempt

array of objects

The payment intent associated with the session. Payment intent is created when the session is created.

paymentIntentAttempt

object

string

required

createdAt

date-time

updatedAt

date-time

errorCode

string

account_closed account_information_mismatch account_invalid account_number_invalid amount_too_large amount_too_small api_key_expired authentication_required balance_insufficient account_bad_routing_numbers account_declined account_exists account_restricted account_unusable account_unverified billing_invalid_mandate capture_charge_authorization_expired capture_unauthorized_payment charge_already_captured charge_already_refunded charge_disputed charge_exceeds_source_limit charge_expired_for_capture charge_invalid_parameter charge_not_refundable clearing_code_unsupported country_code_invalid country_unsupported coupon_expired customer_max_payment_methods customer_max_subscriptions debit_not_authorized email_invalid expired_card idempotency_key_in_use incorrect_address incorrect_number insufficient_funds intent_invalid_state intent_verification_method_missing invalid_characters invalid_charge_amount invalid_source_usage invoice_no_customer_line_items invoice_no_payment_method_types invoice_no_subscription_line_items invoice_not_editable invoice_on_behalf_of_not_editable invoice_payment_intent_requires_action invoice_upcoming_none livemode_mismatch lock_timeout missing no_account parameter_invalid_empty parameter_invalid_integer parameter_invalid_string_blank parameter_invalid_string_empty parameter_missing parameter_unknown parameters_exclusive payment_intent_action_required payment_intent_authentication_failure payment_intent_incompatible_payment_method payment_intent_invalid_parameter payment_intent_mandate_invalid payment_intent_payment_attempt_expired payment_intent_payment_attempt_failed payment_intent_unexpected_state payment_method_billing_details_address_missing payment_method_configuration_failures payment_method_currency_mismatch payment_method_customer_decline payment_method_invalid_parameter payment_method_invalid_parameter_testmode payment_method_not_available payment_method_provider_decline payment_method_provider_timeout payment_method_unactivated payment_method_unexpected_state payment_method_unsupported_type payout_reconciliation_not_ready payouts_limit_exceeded payouts_not_allowed postal_code_invalid processing_error product_inactive progressive_onboarding_limit_exceeded rate_limit refer_to_customer refund_disputed_payment resource_already_exists resource_missing return_intent_already_processed routing_number_invalid secret_key_required setup_attempt_failed setup_intent_authentication_failure setup_intent_invalid_parameter setup_intent_mandate_invalid setup_intent_setup_attempt_expired setup_intent_unexpected_state shipping_calculation_failed sku_inactive status_transition_invalid tax_id_invalid taxes_calculation_failed testmode_charges_only tls_version_unsupported token_already_used token_in_use transfer_source_balance_parameters_mismatch transfers_not_allowed url_invalid

type

string

required

api_error card_error idempotency_error invalid_request_error chain_error unknown

declineCode

string

paymentIntentId

uuid

paymentMethodType

string

superfluid wallet allowance_based_recurring stripe binance_pay

docUrl

string

status

string

required

requires_payment_method requires_confirmation requires_action processing requires_capture canceled succeeded

taxRateIds

array of strings

taxRateIds

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.copperx.dev/api/v1/invoices/id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200

500