Endpoint
GET https://api.gumroad.com/v2/sales/:id
Authentication
Requires theview_sales OAuth scope.
Path Parameters
The unique external ID of the sale to retrieve.
Response
Returns a sale object if a valid identifier was provided.Indicates if the request was successful.
The sale object.
Show Sale object properties
Show Sale object properties
Unique identifier for the sale (obfuscated).
Purchaser’s email address.
Seller’s unique identifier (obfuscated).
Human-readable time since the sale (e.g., “2 days ago”).
Formatted date and time of the sale in seller’s timezone.
ISO 8601 timestamp of when the sale was created.
Product’s external identifier.
Name of the product sold.
Unique permalink for the product.
Whether the product has variants.
Sale price in cents.
Gumroad’s fee in cents.
Human-readable formatted price with currency symbol.
Total transaction amount formatted with currency symbol.
Currency symbol for the transaction.
Amount that can still be refunded, formatted with currency.
Numeric order identifier.
Email used for the purchase.
Purchaser’s full name.
Purchaser’s external ID if they have a Gumroad account.
Street address for physical products.
City for physical products.
State or province.
ZIP or postal code.
Country name.
Two-letter ISO country code.
Whether the sale has been fully refunded.
Whether the sale has been partially refunded.
Whether the sale has been charged back.
Whether the sale is disputed (same as chargedback).
Whether a chargeback dispute was won.
Subscription external ID if this is a recurring billing sale.
Billing interval for subscriptions (e.g., “monthly”, “yearly”).
Whether this is a recurring charge (not the initial subscription purchase).
Whether the subscription has been cancelled.
Whether the subscription has ended.
Whether the free trial has ended.
Variant selections as key-value pairs.Example:
{"Size": "Large", "Color": "Blue"}Human-readable string of variants with quantities.
Whether variants were selected for this purchase.
Custom field values as key-value pairs.Example:
{"Company": "Acme Corp", "License Type": "Team"}Whether custom fields were collected.
Quantity purchased.
Whether the order has been marked as shipped (physical products).
Tracking URL for shipments.
License key for licensed products.
Whether this is a recurring billing product.
Whether the product is a physical good.
Whether the buyer opted in to be contacted.
Whether the buyer is following the seller.
Referring URL for the purchase.
Whether this purchase was a gift sent to someone.
Whether this purchase was received as a gift.
Email of the person who sent the gift.
Email of the gift recipient.
Whether this is a bundle purchase.
Whether this is a product within a bundle.
Example Request
curl "https://api.gumroad.com/v2/sales/ABC123XYZ" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Example Response
{
"success": true,
"sale": {
"id": "ABC123XYZ",
"email": "[email protected]",
"seller_id": "seller456",
"timestamp": "2 days ago",
"daystamp": "January 15, 2024 at 10:30 AM PST",
"created_at": "2024-01-15T10:30:45.000Z",
"product_id": "prod_abc123",
"product_name": "My Awesome Product",
"product_permalink": "myproduct",
"product_has_variants": true,
"price": 2999,
"gumroad_fee": 314,
"formatted_display_price": "$29.99",
"formatted_total_price": "$29.99",
"currency_symbol": "$",
"amount_refundable_in_currency": "$29.99",
"order_id": 123456789,
"purchase_email": "[email protected]",
"full_name": "John Doe",
"purchaser_id": "user_789",
"street_address": "123 Main St",
"city": "San Francisco",
"state": "CA",
"zip_code": "94102",
"country": "United States",
"country_iso2": "US",
"refunded": false,
"partially_refunded": false,
"chargedback": false,
"disputed": false,
"dispute_won": false,
"subscription_id": null,
"variants": {
"Size": "Large",
"Color": "Blue"
},
"has_variants": true,
"custom_fields": {
"Company": "Acme Corp"
},
"has_custom_fields": true,
"quantity": 1,
"shipped": false,
"is_recurring_billing": false,
"is_product_physical": false,
"can_contact": true,
"is_following": false,
"referrer": "https://twitter.com",
"card": {
"visual": "4242",
"type": "Visa"
},
"is_gift_sender_purchase": false,
"is_gift_receiver_purchase": false,
"is_bundle_purchase": false,
"is_bundle_product_purchase": false
}
}
Error Response
If the sale is not found or doesn’t belong to the authenticated user:{
"success": false,
"message": "The sale was not found."
}
Error Codes
Bad Request - Invalid sale ID format
Unauthorized - Invalid or missing access token
Forbidden - Token does not have
view_sales scopeNot Found - Sale does not exist or does not belong to the authenticated user