Subscribe and Save
get_subscribe_and_saveGet Amazon Subscribe & Save offer status, historical snapshots, and Amazon-provided Subscribe & Save metrics.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| skus | No | Filter metrics by SKU where Amazon supports SKU filters. | |
| view | No | Data view. Defaults to offers, or offer_history when start_date/end_date is provided without a view. Use offer_metrics for ASIN/SKU metrics and seller_metrics for seller/brand-level retention and revenue metrics. | |
| asins | No | Filter by specific ASINs. Live offers are capped at 20 ASINs per call; metrics support depends on Amazon's view/filter rules. | |
| limit | No | Max rows to return (1-500, default 20). Live offers are capped at 100 by Amazon. | |
| offset | No | Pagination offset (0-100000, default 0). Use the returned pagination.next_offset to continue. | |
| metrics | No | Optional Amazon metric allowlist for seller_metrics. Omit for Amazon's default/all metrics unless using ASIN/SKU/fulfillment filters. | |
| end_date | No | Optional. YYYY-MM-DD. Defaults to today for offer_history and metrics views. | |
| start_date | No | Optional. YYYY-MM-DD. For offer_history, reads stored snapshots. For metrics views, defaults to a 30-day window ending at end_date/today. | |
| brand_names | No | Filter seller_metrics by brand name where Amazon supports brand filters. Retention metrics are brand-filterable for US marketplace data. | |
| include_raw_rows | No | False returns compact rows. Default true. | |
| time_period_type | No | Metrics period type for offer_metrics and seller_metrics. | PERFORMANCE |
| include_diagnostics | No | True may add expanded freshness diagnostics. Basic empty-result data-window diagnostics are included by default when available. | |
| aggregation_frequency | No | Metrics aggregation frequency for offer_metrics and seller_metrics. | WEEK |
| fulfillment_channel_types | No | Filter metrics by fulfillment channel type where supported. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| evidence | No |