Get Refund

GET

refunds

{id}

curl https://api.alguna.io/refunds/ref_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"

const refund = await alguna.refunds.get('ref_abc123');

{
  "id": "ref_abc123",
  "amount": "99.00",
  "status": "succeeded",
  "currency": "USD",
  "accountId": "acc_xyz789",
  "paymentId": "pay_def456",
  "reason": "Customer requested refund",
  "failureReason": null,
  "processorId": "re_stripe_123",
  "externalId": "re_1234567890",
  "externalUrl": "https://dashboard.stripe.com/refunds/re_1234567890",
  "createdAt": "2024-01-20T10:00:00Z",
  "updatedAt": "2024-01-20T10:05:00Z"
}

Retrieve a refund by its ID.

string

required

The refund ID.

curl https://api.alguna.io/refunds/ref_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"

const refund = await alguna.refunds.get('ref_abc123');

{
  "id": "ref_abc123",
  "amount": "99.00",
  "status": "succeeded",
  "currency": "USD",
  "accountId": "acc_xyz789",
  "paymentId": "pay_def456",
  "reason": "Customer requested refund",
  "failureReason": null,
  "processorId": "re_stripe_123",
  "externalId": "re_1234567890",
  "externalUrl": "https://dashboard.stripe.com/refunds/re_1234567890",
  "createdAt": "2024-01-20T10:00:00Z",
  "updatedAt": "2024-01-20T10:05:00Z"
}

string

Unique identifier for the refund.

string

Refund amount as a decimal string.

string

Refund status: pending, processing, succeeded, failed, or canceled.

string

Currency code.

string

The account that received the refund.

string

The original payment that was refunded.

string

Reason for the refund.

string

Reason for failure if status is failed.

string

Payment processor’s internal refund ID.

string

External reference ID from the payment processor.

string

Link to view the refund in the payment processor’s dashboard.

string

ISO 8601 timestamp of creation.

string

ISO 8601 timestamp of last update.

List SubscriptionsRetrieve a paginated list of subscriptions with optional filtering and sorting

⌘I

curl https://api.alguna.io/refunds/ref_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"

const refund = await alguna.refunds.get('ref_abc123');

{
  "id": "ref_abc123",
  "amount": "99.00",
  "status": "succeeded",
  "currency": "USD",
  "accountId": "acc_xyz789",
  "paymentId": "pay_def456",
  "reason": "Customer requested refund",
  "failureReason": null,
  "processorId": "re_stripe_123",
  "externalId": "re_1234567890",
  "externalUrl": "https://dashboard.stripe.com/refunds/re_1234567890",
  "createdAt": "2024-01-20T10:00:00Z",
  "updatedAt": "2024-01-20T10:05:00Z"
}

API Reference

Billing Events & Usage Metering

Bundles

Credit Grants

Credit Notes

Customers

Invoices

Plans

Products

Refunds

Subscriptions

Subscription Versions

Wallets