Skip to content
Changelog

Report a bug

Gumroad integration: operations for AI agents

Gumroad connects to Type.com as an integration. This page lists the 85 operations documented for Claude and Codex in Type.com: 35 read, 33 write, 17 destructive.

About Gumroad

Gumroad simplifies selling digital goods, physical products, and memberships by offering a streamlined checkout, marketing tools, and direct payout options

Categories: Commerce & Payments

How to connect Gumroad to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

85 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

85 operations listed.

CustomFields

  • Read

    Retrieve all of the existing custom fields for a product.

    Retrieve all of the existing custom fields for a product.

    GET /v2/products/{product_id}/custom_fields

  • Write

    Create a new custom field for a product.

    Create a new custom field for a product.

    POST /v2/products/{product_id}/custom_fields

  • Write

    Edit an existing product's custom field.

    Edit an existing product's custom field.

    PUT /v2/products/{product_id}/custom_fields/{name}

  • Destructive

    Permanently delete a product's custom field.

    Permanently delete a product's custom field.

    DELETE /v2/products/{product_id}/custom_fields/{name}

Sales

  • Read

    Retrieves all of the successful sales by the authenticated user

    Retrieves all of the successful sales by the authenticated user. Available with the 'view_sales' scope.

    GET /v2/sales

  • Read

    Retrieves the details of a sale by this user

    Retrieves the details of a sale by this user. Available with the 'view_sales' scope.

    GET /v2/sales/{id}

  • Write

    Marks a sale as shipped

    Marks a sale as shipped. Available with the 'mark_sales_as_shipped' scope.

    PUT /v2/sales/{id}/mark_as_shipped

  • Write

    Restores the buyer's access to a sale that was previously revoked

    Restores the buyer's access to a sale that was previously revoked. Available with the 'edit_sales' scope.

    PUT /v2/sales/{id}/undo_revoke_access

  • Write

    Resend the purchase receipt to the customer's email

    Resend the purchase receipt to the customer's email. Available with the 'edit_sales' scope.

    POST /v2/sales/{id}/resend_receipt

  • Destructive

    Refunds a sale

    Refunds a sale. Available with the 'edit_sales' scope.

    PUT /v2/sales/{id}/refund

  • Destructive

    Revokes the buyer's access to a sale without refunding it

    Revokes the buyer's access to a sale without refunding it. The sale stays in the seller's records and the buyer loses library/download access. Same rules as the dashboard Customers page: refused for refunded sales, physical products, and subscriptions. Available with the 'edit_sales' scope.

    PUT /v2/sales/{id}/revoke_access

Payouts

  • Read

    Retrieves all of the payouts for the authenticated user

    Retrieves all of the payouts for the authenticated user. Available with the 'view_payouts' scope.

    GET /v2/payouts

  • Read

    Retrieves the details of a specific payout by this user

    Retrieves the details of a specific payout by this user. Available with the 'view_payouts' scope.

    GET /v2/payouts/{id}

  • Read

    Retrieves the details of upcoming payouts for this user

    Retrieves the details of upcoming payouts for this user. There can be up to 2 upcoming payouts at any given time. Available with the 'view_payouts' scope.

    GET /v2/payouts/upcoming

Workflows

  • Read

    Retrieve the seller's active workflows in newest-first order

    Retrieve the seller's active workflows in newest-first order. Requires the edit_emails or account scope.

    GET /v2/workflows

  • Read

    Retrieve one active workflow with its email steps and delivery statistics

    Retrieve one active workflow with its email steps and delivery statistics. Requires the edit_emails or account scope.

    GET /v2/workflows/{id}

  • Write

    Add one email step without changing the workflow publication state

    Add one email step without changing the workflow publication state. The new step inherits the workflow state. A published workflow schedules eligible past recipients when send_to_past_customers is true. Abandoned cart workflows do not support added steps. Requires the edit_emails or account scope.

    POST /v2/workflows/{workflow_id}/emails

  • Write

    Update one email step without changing the workflow publication state

    Update one email step without changing the workflow publication state. Omitted fields stay unchanged. Supply at least one write parameter. Supply delay_amount and delay_unit together. A delay change can reschedule recipients. Abandoned cart workflows allow subject and body changes, but not delay changes. Requires the edit_emails or account scope.

    PUT /v2/workflows/{workflow_id}/emails/{email_id}

ProductReviews

  • Read

    Retrieves the reviews shown on one of the authenticated user's product pages, newest first

    Retrieves the reviews shown on one of the authenticated user's product pages, newest first. Available with any read scope. Only reviews that appear publicly are returned — a review is included when the buyer left a written message or an approved video. Star-only ratings with no message are counted in the product's average_rating but are not returned here.

    GET /v2/products/{product_id}/reviews

User

  • Read

    Retrieve the user's data.

    Retrieve the user's data.

    GET /v2/user

  • Read

    Retrieve your profile's custom HTML landing page.

    Retrieve your profile's custom HTML landing page.

    GET /v2/user/custom_html

  • Read

    Sanitize profile HTML and return the result without saving.

    Sanitize profile HTML and return the result without saving.

    POST /v2/user/preview_custom_html

  • Write

    Publish or clear your profile's custom HTML landing page.

    Publish or clear your profile's custom HTML landing page.

    PUT /v2/user/custom_html

Earnings

  • Read

    Retrieves an annual earnings breakdown for the authenticated user, matching the totals reported in the Tax Center

    Retrieves an annual earnings breakdown for the authenticated user, matching the totals reported in the Tax Center. Available with the 'view_tax_data' scope. Only available to US-based sellers with the tax center enabled. Fully refunded sales are excluded from every aggregate.

    GET /v2/earnings

TaxForms

  • Read

    Retrieves tax forms (1099-K, 1099-MISC) generated for the authenticated user

    Retrieves tax forms (1099-K, 1099-MISC) generated for the authenticated user. Available with the 'view_tax_data' scope. Only available to US-based sellers with the tax center enabled.

    GET /v2/tax_forms

  • Read

    Downloads the PDF for a specific tax form

    Downloads the PDF for a specific tax form. Available with the 'view_tax_data' scope. Response is the raw PDF on success (Content-Type: application/pdf, Content-Disposition: attachment); a JSON error envelope on failure.

    GET /v2/tax_forms/{year}/{tax_form_type}/download

Files

  • Write

    Start a multipart upload

    Start a multipart upload. Returns presigned URLs for each part. Requires the edit_products scope.

    POST /v2/files/presign

  • Write

    Finalize the multipart upload started by /v2/files/presign

    Finalize the multipart upload started by /v2/files/presign. Returns the final file_url. Requires the edit_products scope.

    POST /v2/files/complete

  • Destructive

    Cancel a multipart upload started by /v2/files/presign

    Cancel a multipart upload started by /v2/files/presign. Requires the edit_products scope.

    POST /v2/files/abort

ResourceSubscriptions

  • Read

    Show all active subscriptions of user for the input resource.

    Show all active subscriptions of user for the input resource.

    GET /v2/resource_subscriptions

  • Write

    Send a test event to a resource subscription's post_url

    Send a test event to a resource subscription's post_url. The payload uses the subscription's resource_name and is marked with test: true . It is built from your most recent matching event when one exists (source "last_event"), otherwise from sample data with the documented fields (source "sample"). It is a copy of the data only: no purchase, refund or dispute is created, and the sale is not changed. Only subscriptions created by the calling application can be tested.

    POST /v2/resource_subscriptions/{resource_subscription_id}/test_event

  • Write

    Subscribe to sale, refund, dispute, dispute_won, cancellation, subscription_updated, subscription_ended or subscription_

    Subscribe to sale, refund, dispute, dispute_won, cancellation, subscription_updated, subscription_ended or subscription_restarted resource notifications.

    PUT /v2/resource_subscriptions

  • Destructive

    Unsubscribe from a resource.

    Unsubscribe from a resource.

    DELETE /v2/resource_subscriptions/{resource_subscription_id}

OfferCodes

  • Read

    Retrieve all of the existing offer codes for a product

    Retrieve all of the existing offer codes for a product. Either amount_cents or percent_off will be returned depending if the offer code is a fixed amount off or a percentage off. A universal offer code is one that applies to all products.

    GET /v2/products/{product_id}/offer_codes

  • Read

    Retrieve the details of a specific offer code of a product

    Retrieve the details of a specific offer code of a product

    GET /v2/products/{product_id}/offer_codes/{id}

  • Read

    List all non-deleted offer codes in your store, including scheduled and expired codes

    List all non-deleted offer codes in your store, including scheduled and expired codes. This endpoint requires view_sales or edit_products.

    GET /v2/offer_codes

  • Read

    Read one of your store's offer codes by its ID

    Read one of your store's offer codes by its ID. This endpoint requires view_sales or edit_products.

    GET /v2/offer_codes/{id}

  • Write

    Create a new offer code for a product

    Create a new offer code for a product. Default offer code is in cents. A universal offer code is one that applies to all products.

    POST /v2/products/{product_id}/offer_codes

  • Write

    Edit an offer code

    Edit an offer code. Requires edit_products scope.

    PUT /v2/offer_codes/{id}

  • Write

    Edit an offer code

    Edit an offer code. Requires edit_products scope.

    PUT /v2/products/{product_id}/offer_codes/{id}

  • Destructive

    Permanently delete a product's offer code.

    Permanently delete a product's offer code.

    DELETE /v2/products/{product_id}/offer_codes/{id}

Licenses

  • Write

    Verify a license

    Verify a license

    POST /v2/licenses/verify

  • Write

    Enable a license

    Enable a license

    PUT /v2/licenses/enable

  • Write

    Decrement the uses count of a license

    Decrement the uses count of a license

    PUT /v2/licenses/decrement_uses_count

  • Destructive

    Disable a license

    Disable a license

    PUT /v2/licenses/disable

  • Destructive

    Rotate a license key

    Rotate a license key. The old license key will no longer be valid.

    PUT /v2/licenses/rotate

PublicProfile

  • Read

    Retrieve a creator's public profile — no authentication required

    Retrieve a creator's public profile — no authentication required. Returns the creator's display information (name, bio, avatar, social links) along with products visible in their public profile product sections. Append .json to any creator profile URL. Never exposes seller-private fields such as email, balance, or tax information.

    GET https://[username].gumroad.com/.json

Thumbnails

  • Write

    Set a product thumbnail from a signed upload or publicly accessible image URL

    Set a product thumbnail from a signed upload or publicly accessible image URL. URL thumbnails are downloaded and stored by Gumroad, so the URL must be reachable over HTTP(S) and cannot be a private or pre-signed upload URL. Thumbnail images must be square, at least 600x600px, smaller than 5 MB, and in JPG, PNG, or GIF format. Requires the edit_products scope.

    POST /v2/products/{product_id}/thumbnail

  • Destructive

    Delete a product thumbnail

    Delete a product thumbnail. Requires the edit_products scope.

    DELETE /v2/products/{product_id}/thumbnail

PublicProductPage

  • Read

    Retrieve the public, display data for a product page — no authentication required

    Retrieve the public, display data for a product page — no authentication required. This is the read/display counterpart to the OAuth Products API: it returns exactly the information shown on the rendered product page (price, covers, description, reviews, variants, and social proof), and never exposes buyer-specific, seller-private, or analytics fields. Append .json to any public product URL.

    GET https://[seller].gumroad.com/l/{permalink}.json

RefundPolicy

  • Read

    Retrieve the account-level refund policy.

    Retrieve the account-level refund policy.

    GET /v2/refund_policy

  • Write

    Update the account-level refund policy

    Update the account-level refund policy. Requires the edit_products scope. Updates are rejected when the account-level policy is not in effect for the seller; in that case, set product-level policies via the refund_period and refund_fine_print parameters on POST /v2/products and PUT /v2/products/:id.

    PUT /v2/refund_policy

Covers

  • Write

    Add a cover to a product from a publicly accessible URL

    Add a cover to a product from a publicly accessible URL. The server fetches the URL and stores a copy, so the URL must be reachable over HTTP(S) and cannot be a private or pre-signed upload URL. Accepts image (JPEG, PNG, GIF) and video URLs, as well as YouTube and Vimeo URLs. Requires the edit_products scope.

    POST /v2/products/{product_id}/covers

  • Destructive

    Delete a cover from a product

    Delete a cover from a product. Requires the edit_products scope.

    DELETE /v2/products/{product_id}/covers/{id}

Variants

  • Read

    Retrieve the details of a variant category of a product.

    Retrieve the details of a variant category of a product.

    GET /v2/products/{product_id}/variant_categories/{id}

  • Read

    Retrieve all of the existing variant categories of a product.

    Retrieve all of the existing variant categories of a product.

    GET /v2/products/{product_id}/variant_categories

  • Read

    Retrieve the details of a variant of a product.

    Retrieve the details of a variant of a product.

    GET /v2/products/{product_id}/variant_categories/{variant_category_id}/variants/{id}

  • Read

    Retrieve all of the existing variants in a variant category.

    Retrieve all of the existing variants in a variant category.

    GET /v2/products/{product_id}/variant_categories/{variant_category_id}/variants

  • Write

    Create a new variant category on a product.

    Create a new variant category on a product.

    POST /v2/products/{product_id}/variant_categories

  • Write

    Edit a variant category of an existing product.

    Edit a variant category of an existing product.

    PUT /v2/products/{product_id}/variant_categories/{id}

  • Write

    Create a new variant of a product.

    Create a new variant of a product.

    POST /v2/products/{product_id}/variant_categories/{variant_category_id}/variants

  • Write

    Edit a variant of an existing product.

    Edit a variant of an existing product.

    PUT /v2/products/{product_id}/variant_categories/{variant_category_id}/variants/{id}

  • Destructive

    Permanently delete a variant category of a product.

    Permanently delete a variant category of a product.

    DELETE /v2/products/{product_id}/variant_categories/{id}

  • Destructive

    Permanently delete a variant of a product.

    Permanently delete a variant of a product.

    DELETE /v2/products/{product_id}/variant_categories/{variant_category_id}/variants/{id}

Subscribers

  • Read

    Retrieves all of the active subscribers for one of the authenticated user's products

    Retrieves all of the active subscribers for one of the authenticated user's products. Available with the 'view_sales' scope A subscription is terminated if any of failed_at, ended_at, or cancelled_at timestamps are populated and are in the past. A subscription's status can be one of: alive, payment_method_update_required, pending_cancellation, pending_failure, failed_payment, fixed_subscription_period_ended, cancelled.

    GET /v2/products/{product_id}/subscribers

  • Read

    Retrieves the details of a subscriber to this user's product

    Retrieves the details of a subscriber to this user's product. Available with the 'view_sales' scope.

    GET /v2/subscribers/{id}

Products

  • Read

    Retrieve the full product category list

    Retrieve the full product category list. Use a category's path as the category parameter when creating or updating products.

    GET /v2/categories

  • Read

    Retrieve all of the existing products for the authenticated user.

    Retrieve all of the existing products for the authenticated user.

    GET /v2/products

  • Read

    Retrieve the details of a product.

    Retrieve the details of a product.

    GET /v2/products/{id}

  • Write

    Create a new product

    Create a new product. The product is published immediately unless you pass draft=true or published=false . If publishing is blocked (for example, your email address is not confirmed or no payout method is set up), the product is saved as a draft and the response includes a warning explaining why; publish it later with PUT /v2/products/:id/enable . Requires the edit_products or account scope.

    POST /v2/products

  • Write

    Update an existing product

    Update an existing product. Send only the fields you want to change. Sending files , tags , or rich_content replaces the entire collection. Requires the edit_products or account scope.

    PUT /v2/products/{id}

  • Write

    Enable an existing product.

    Enable an existing product.

    PUT /v2/products/{id}/enable

  • Destructive

    Permanently delete a product.

    Permanently delete a product.

    DELETE /v2/products/{id}

  • Destructive

    Disable an existing product.

    Disable an existing product.

    PUT /v2/products/{id}/disable

Media

  • Read

    Lists the files in the authenticated user's media library, newest first

    Lists the files in the authenticated user's media library, newest first. Requires the view_profile scope. The media library hosts images on Gumroad's own storage so they can be displayed on your public pages. Custom product and profile pages render under a Content Security Policy that blocks images loaded from other sites — only inline data: / blob: images and Gumroad's own public asset hosts are allowed — so an image hosted elsewhere will not load there. Upload it here first and embed the returned url . Files belong to your account rather than to a single product, so the same image can be used across as many pages as you like.

    GET /v2/media

  • Write

    Uploads an image to the media library, either from a publicly reachable URL that Gumroad downloads for you or from a sig

    Uploads an image to the media library, either from a publicly reachable URL that Gumroad downloads for you or from a signed blob ID produced by a direct upload. Requires the edit_profile scope. Images may be up to 10 MB, and the file type is determined by inspecting the bytes rather than trusting the file extension. SVG is not accepted, because these files are served from a Gumroad domain and SVG can carry script. An account may hold up to 500 files at a time. Uploads are rate limited to 20 per 10 minutes. Accounts that are suspended or closed cannot upload, and a token holding only the broad account scope is rejected — this endpoint requires edit_profile specifically. To use signed_blob_id , first reserve a direct upload with POST /v2/direct_uploads passing purpose=media , upload the bytes to the URL it returns, then pass the returned signed ID here.

    POST /v2/media

  • Destructive

    Deletes a file from the media library

    Deletes a file from the media library. Requires the edit_profile scope. The file leaves your library immediately and the hosted copy is queued for removal, so any page still embedding its URL will show a broken image once the purge runs.

    DELETE /v2/media/{id}

Emails

  • Read

    Retrieve the seller's audience emails

    Retrieve the seller's audience emails. Use type to filter by published, scheduled, or draft emails. Requires the edit_emails or account scope.

    GET /v2/emails

  • Read

    Retrieve the details of a specific audience email

    Retrieve the details of a specific audience email. Requires the edit_emails or account scope.

    GET /v2/emails/{id}

  • Write

    Create a draft audience email, or send it immediately by passing publish=true (or draft=false)

    Create a draft audience email, or send it immediately by passing publish=true (or draft=false). Scheduling is done on an existing email via the schedule endpoint. Requires the edit_emails or account scope.

    POST /v2/emails

  • Write

    Send a preview of an audience email to the seller's email address

    Send a preview of an audience email to the seller's email address. Requires the edit_emails or account scope.

    POST /v2/emails/{id}/preview

  • Write

    Publish a draft audience email and send it to its audience

    Publish a draft audience email and send it to its audience. Requires the edit_emails or account scope.

    POST /v2/emails/{id}/send

  • Write

    Schedule a draft audience email to publish at a set time

    Schedule a draft audience email to publish at a set time. Rescheduling an already-scheduled email replaces its publish time. Schedules only the email: the audience is fixed at publish, and sending eligibility is re-validated at send time. Requires the edit_emails or account scope.

    POST /v2/emails/{id}/schedule

  • Destructive

    Cancel a scheduled audience email and turn it back into a draft

    Cancel a scheduled audience email and turn it back into a draft. The pending publish job is cancelled. Requires the edit_emails or account scope.

    POST /v2/emails/{id}/unschedule

  • Destructive

    Delete an audience email

    Delete an audience email. Requires the edit_emails or account scope.

    DELETE /v2/emails/{id}

See How connections work for access and permissions, or browse all integrations.