Search a pricing plan subscription

POST

/v:version/pricing-plan-subscriptions/search

POST

/v:version/pricing-plan-subscriptions/search

curl -X POST https://test.api.solvimon.com/v1/pricing-plan-subscriptions/search \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "filter_fields": [
    {
      "name": "customer_id",
      "value": "cust_UwDeeN0vxxHxMPCaeb1R"
    },
    {
      "name": "status",
      "values": [
        "ACTIVE",
        "DRAFT"
      ]
    }
  ]
}'

{
  "data": [
    {
      "object_type": "string",
      "id": "string",
      "created_at": "string",
      "updated_at": "string",
      "activated_at": "string",
      "status": "DRAFT",
      "reference": "string",
      "name": "string",
      "purchase_order_number": "string",
      "customer_id": "string",
      "customer_reference": "string",
      "customer": {
        "object_type": "string",
        "id": "string",
        "created_at": "string",
        "parent_customer_id": "string",
        "parent_customer_ids": [
          "string"
        ],
        "reference": "string",
        "status": "DRAFT",
        "timezone": "string",
        "type": "ORGANIZATION",
        "email": "string",
        "notification_preferences": [
          {
            "type": "INVOICE",
            "channels": [
              {
                "type": "EMAIL",
                "enabled": true
              }
            ]
          }
        ],
        "locale": "string",
        "individual": {
          "name": {
            "first_name": "string",
            "last_name": "string",
            "infix": "string"
          },
          "residential_address": {
            "line1": "string",
            "line2": "string",
            "city": "string",
            "postal_code": "string",
            "state": "string",
            "country": "AD"
          }
        },
        "organization": {
          "legal_name": "string",
          "tax_id": "string",
          "tax_ids": [
            {
              "id": "string",
              "type": "GENERIC_TAX_ID",
              "display_name": "string",
              "tax_id_validation_result": {
                "id": "string",
                "validation_date": "string",
                "source": "string",
                "valid": "VALID",
                "message": "string"
              }
            }
          ],
          "registration_number": "string",
          "tax_exempt": true,
          "tax_exempt_note": "string",
          "registered_address": {
            "line1": "string",
            "line2": "string",
            "city": "string",
            "postal_code": "string",
            "state": "string",
            "country": "AD"
          },
          "tax_registrations": [
            {
              "id": "string",
              "description": "string",
              "tax_id": "string",
              "tax_ids": [
                {
                  "id": "string",
                  "type": "GENERIC_TAX_ID",
                  "display_name": "string",
                  "tax_id_validation_result": {
                    "id": "string",
                    "validation_date": "string",
                    "source": "string",
                    "valid": "VALID",
                    "message": "string"
                  }
                }
              ],
              "registration_number": "string",
              "registered_address": {
                "line1": "string",
                "line2": "string",
                "city": "string",
                "postal_code": "string",
                "state": "string",
                "country": "AD"
              }
            }
          ]
        },
        "custom_fields": [
          {
            "id": "string",
            "reference": "string",
            "value": "string",
            "values": [
              "string"
            ],
            "integration_details": {
              "id": "string",
              "reference": "string",
              "payment_gateway_variant": "ADYEN",
              "adyen": {
                "recurring_detail_reference": "string"
              },
              "stripe": {
                "payment_method_id": "string"
              }
            },
            "integration_id": "string"
          }
        ],
        "pricing_plan_subscription_selector": {
          "data": [
            {
              "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
              "value": "string"
            }
          ],
          "rules": [
            {
              "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
              "type": "EQUALS"
            }
          ],
          "filters": [
            {
              "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
              "type": "EQUALS",
              "value": "string"
            }
          ],
          "fallback": "LATEST"
        },
        "linked_integrations": [
          {
            "id": "string",
            "link_details": [
              {
                "url": "string",
                "custom_field_name": "string"
              }
            ]
          }
        ],
        "roles": [
          "DEFAULT"
        ],
        "seller_details": {
          "default_billing_entity_id": "string"
        },
        "processing_only": true
      },
      "billing_entity_id": "string",
      "billing_entity_reference": "string",
      "billing_entity": {
        "object_type": "string",
        "id": "string",
        "created_at": "string",
        "reference": "string",
        "status": "string",
        "timezone": "string",
        "legal_name": "string",
        "tax_id": "string",
        "tax_ids": [
          {
            "id": "string",
            "type": "GENERIC_TAX_ID",
            "display_name": "string",
            "tax_id_validation_result": {
              "id": "string",
              "validation_date": "string",
              "source": "string",
              "valid": "VALID",
              "message": "string"
            }
          }
        ],
        "registration_number": "string",
        "registered_address": {
          "line1": "string",
          "line2": "string",
          "city": "string",
          "postal_code": "string",
          "state": "string",
          "country": "AD"
        },
        "email": "string",
        "tax_settings": {
          "apply_local_vat_for_missing_tax_id": true
        },
        "tax_registrations": [
          {
            "id": "string",
            "description": "string",
            "tax_id": "string",
            "tax_ids": [
              {
                "id": "string",
                "type": "GENERIC_TAX_ID",
                "display_name": "string",
                "tax_id_validation_result": {
                  "id": "string",
                  "validation_date": "string",
                  "source": "string",
                  "valid": "VALID",
                  "message": "string"
                }
              }
            ],
            "registration_number": "string",
            "registered_address": {
              "line1": "string",
              "line2": "string",
              "city": "string",
              "postal_code": "string",
              "state": "string",
              "country": "AD"
            }
          }
        ],
        "custom_fields": [
          {
            "id": "string",
            "reference": "string",
            "value": "string",
            "values": [
              "string"
            ],
            "integration_details": {
              "id": "string",
              "reference": "string",
              "payment_gateway_variant": "ADYEN",
              "adyen": {
                "recurring_detail_reference": "string"
              },
              "stripe": {
                "payment_method_id": "string"
              }
            },
            "integration_id": "string"
          }
        ],
        "default_customer_country_selector": [
          "AD"
        ],
        "default_billing_currency_selector": [
          "AED"
        ],
        "linked_integrations": [
          {
            "id": "string",
            "link_details": [
              {
                "url": "string",
                "custom_field_name": "string"
              }
            ]
          }
        ]
      },
      "billing_period": {
        "type": "DAY",
        "value": 1
      },
      "billing_currency": "AED",
      "due_date_configuration": {
        "type": "PERIOD_AFTER_INVOICE_DATE",
        "period": {
          "type": "DAY",
          "value": 1
        }
      },
      "initial_term": {
        "type": "DAY",
        "value": 1
      },
      "renewal_term": {
        "type": "DAY",
        "value": 1
      },
      "auto_renewal": true,
      "type": "QUOTE",
      "variant": "DEFAULT",
      "billing_time": "EXACT",
      "combine": true,
      "quote_version_id": "string",
      "upgraded_from_pricing_plan_subscription_id": "string",
      "upgraded_to_pricing_plan_subscription_id": "string",
      "payment_acceptor_ids": [
        "string"
      ],
      "payment_acceptors": [
        {
          "object_type": "string",
          "id": "string",
          "billing_entity_id": "string",
          "customer_id": "string",
          "reference": "string",
          "name": "string",
          "description": "string",
          "type": "BANK_ACCOUNT",
          "bank_account": {
            "type": "IBAN",
            "iban": "string",
            "country": "string",
            "bic": "string",
            "bank_name": "string",
            "bank_address": {
              "line1": "string",
              "line2": "string",
              "city": "string",
              "postal_code": "string",
              "state": "string",
              "country": "AD"
            },
            "account_number_and_bic": {
              "account_number": "string",
              "bank_code": "string",
              "bic": "string"
            },
            "uk_local": {
              "account_number": "string",
              "sort_code": "string"
            },
            "us_local": {
              "account_number": "string",
              "account_type": "CHECKING",
              "bank_code": "string",
              "routing_number": "string"
            },
            "br_local": {
              "branch": "string",
              "account_number": "string",
              "bic": "string"
            },
            "ar_local": {
              "cbu": "string",
              "account_number": "string",
              "bic": "string"
            },
            "mx_local": {
              "clabe": "string",
              "account_number": "string",
              "bic": "string"
            },
            "account_number": "string",
            "bank_code": "string",
            "routing_number": "string",
            "account_type": "CHECKING"
          },
          "payment_gateway": {
            "integration_id": "string",
            "integration": {
              "object_type": "string",
              "id": "string",
              "reference": "string",
              "name": "string",
              "description": "string",
              "status": "DRAFT",
              "message": "string",
              "type": "PAYMENT_GATEWAY",
              "variant": "DEFAULT",
              "paragon_settings": {
                "paragon_external_id": "string"
              },
              "authentication": {
                "api_key": {
                  "header": "string",
                  "value": "string"
                },
                "client_credentials": {
                  "client_id": "string",
                  "client_secret": "string"
                },
                "username_password": {
                  "username": "string",
                  "password": "string"
                }
              },
              "payment_gateway": {
                "variant": "ADYEN",
                "adyen": {
                  "company_account": "string",
                  "environment": "LIVE",
                  "live_prefix": "string",
                  "merchant_accounts": [
                    "string"
                  ],
                  "public_key": "string",
                  "signing_secret": "string",
                  "ownership": "PLATFORM",
                  "system_ownership_details": {
                    "account_holder_id": "string",
                    "balance_account_id": "string",
                    "legal_entity_id": "string",
                    "store_id": "string"
                  },
                  "balance_platform_details": {
                    "account": "string",
                    "authentication": {
                      "api_key": {
                        "header": "string",
                        "value": "string"
                      },
                      "client_credentials": {
                        "client_id": "string",
                        "client_secret": "string"
                      },
                      "username_password": {
                        "username": "string",
                        "password": "string"
                      }
                    }
                  },
                  "legal_entity_manager_details": {
                    "authentication": {
                      "api_key": {
                        "header": "string",
                        "value": "string"
                      },
                      "client_credentials": {
                        "client_id": "string",
                        "client_secret": "string"
                      },
                      "username_password": {
                        "username": "string",
                        "password": "string"
                      }
                    }
                  },
                  "enabled_payment_methods": [
                    "string"
                  ]
                },
                "stripe": {
                  "public_key": "string",
                  "signing_secret": "string"
                }
              },
              "e_invoicing": {
                "mandates": [
                  {
                    "name": "string",
                    "country": "string",
                    "mappings": [
                      {
                        "target": "string",
                        "source": "string",
                        "description": "string"
                      }
                    ],
                    "condition_groups": [
                      {
                        "conditions": [
                          {
                            "field": "string",
                            "comparator_type": "EQUALS",
                            "value": "string"
                          }
                        ]
                      }
                    ],
                    "include_pdf_in_einvoice": true,
                    "supported_file_formats": [
                      {
                        "type": "string",
                        "description": "string"
                      }
                    ]
                  }
                ],
                "processor": "AVALARA"
              },
              "data_export": {
                "variant": "S3",
                "s3": {
                  "bucket_name": "string",
                  "bucket_path": "string",
                  "bucket_region": "string",
                  "authentication_type": "ACCESS_KEY_AND_SECRET",
                  "role_arn": "string",
                  "external_id": "string"
                },
                "bigquery": {
                  "project_id": "string",
                  "dataset_id": "string",
                  "dataset_location": "string",
                  "gcs_bucket_name": "string",
                  "gcs_hmac_key_access_id": "string",
                  "gcs_hmac_key_secret": "string"
                },
                "gcs": {
                  "bucket_region": "string",
                  "bucket_name": "string",
                  "bucket_path": "string",
                  "flattening": true
                },
                "snowflake": {
                  "host": "string",
                  "role": "string",
                  "warehouse": "string",
                  "database": "string",
                  "schema": "string"
                },
                "transport_type": "string"
              },
              "tax_calculation": {
                "billing_entity_id": "string",
                "variant": "AVATAX",
                "ava_tax": {
                  "company_code": "string"
                },
                "custom_tax_codes": [
                  {
                    "field": "INVOICE_COMMITMENT",
                    "value": "string"
                  }
                ],
                "enable_tax_filing": true
              },
              "linked_resources_configurations": [
                {
                  "resource_type": "string",
                  "link_details": [
                    {
                      "base_url": "string",
                      "custom_field_reference": "string"
                    }
                  ]
                }
              ],
              "email_provider": {
                "variant": "SYSTEM",
                "mailgun": {
                  "domain": "string",
                  "region": "US",
                  "plan": "string"
                },
                "delivery_window": {
                  "type": "DAY",
                  "value": 1
                }
              },
              "erp": {
                "variant": "XERO"
              }
            },
            "store_payment_method": true,
            "auto_charge_payment_method": true,
            "collection_type": "LINK",
            "link": {
              "expiry_period": {
                "type": "DAY",
                "value": 1
              }
            },
            "adyen": {
              "auto_rescue": {
                "enabled": true,
                "period": {
                  "type": "DAY",
                  "value": 1
                }
              },
              "merchant_account": "string",
              "allowed_payment_methods": [
                "string"
              ]
            }
          },
          "custom_redirect": {
            "url": "string"
          },
          "status": "DRAFT"
        }
      ],
      "pricing_plan_schedule_infos": [
        {
          "id": "string",
          "pricing_plan_schedule": {
            "object_type": "string",
            "id": "string",
            "type": "TRIAL",
            "status": "DRAFT",
            "approval_status": "PENDING_REVIEW",
            "pricing_plan_subscription_id": "string",
            "pricing_plan_id": "string",
            "pricing_plan_version_id": "string",
            "start_at": "2024-01-15T09:30:00Z",
            "end_at": "2024-01-15T09:30:00Z",
            "pricing_currency": "AED",
            "billing_period": {
              "type": "DAY",
              "value": 1
            },
            "entitlements": [
              {
                "feature_id": "string",
                "feature": {
                  "object_type": "string",
                  "id": "string",
                  "reference": "string",
                  "name": "string",
                  "description": "string",
                  "type": "SWITCH",
                  "enum_values": [
                    "string"
                  ],
                  "meter_value_calculation_id": "string",
                  "meter_value_calculation": {
                    "object_type": "string",
                    "id": "string",
                    "reference": "string",
                    "name": "string",
                    "description": "string",
                    "calculation_type": "SUM",
                    "persist": true,
                    "meter_id": "string",
                    "meter": {
                      "object_type": "string",
                      "id": "string",
                      "reference": "string",
                      "name": "string",
                      "description": "string",
                      "status": "DRAFT",
                      "meter_values": [
                        {
                          "id": "string",
                          "object": {
                            "object_type": "string",
                            "id": "string",
                            "reference": "string",
                            "name": "string",
                            "description": "string",
                            "status": "DRAFT",
                            "type": "NUMBER"
                          },
                          "required": true
                        }
                      ],
                      "meter_properties": [
                        {
                          "id": "string",
                          "object": {
                            "object_type": "string",
                            "id": "string",
                            "reference": "string",
                            "name": "string",
                            "description": "string",
                            "status": "DRAFT",
                            "type": "NUMBER",
                            "enum_values": [
                              "string"
                            ]
                          },
                          "required": true
                        }
                      ]
                    },
                    "meter_value_id": "string",
                    "meter_value": {
                      "object_type": "string",
                      "id": "string",
                      "reference": "string",
                      "name": "string",
                      "description": "string",
                      "status": "DRAFT",
                      "type": "NUMBER"
                    },
                    "meter_property_id": "string",
                    "meter_property": {
                      "object_type": "string",
                      "id": "string",
                      "reference": "string",
                      "name": "string",
                      "description": "string",
                      "status": "DRAFT",
                      "type": "NUMBER",
                      "enum_values": [
                        "string"
                      ]
                    }
                  }
                },
                "feature_reference": "string",
                "override": true,
                "number": "string",
                "switch": true,
                "amount": {
                  "quantity": "string",
                  "currency": "AED"
                },
                "enum": "string",
                "string": "string",
                "overwrite": true
              }
            ],
            "discount": {
              "pricing_item_configs": [
                {
                  "ids": [
                    "string"
                  ],
                  "start_at": "2024-01-15T09:30:00Z",
                  "end_at": "2024-01-15T09:30:00Z",
                  "amount": {
                    "quantity": "string",
                    "currency": "AED"
                  },
                  "percentage": "string",
                  "condition": {
                    "comparator": "EQUALS",
                    "value": {
                      "amount": {
                        "quantity": "string",
                        "currency": "AED"
                      }
                    }
                  }
                }
              ],
              "pricing_items": [
                {
                  "ids": [
                    "string"
                  ],
                  "start_at": "2024-01-15T09:30:00Z",
                  "end_at": "2024-01-15T09:30:00Z",
                  "amount": {
                    "quantity": "string",
                    "currency": "AED"
                  },
                  "percentage": "string",
                  "condition": {
                    "comparator": "EQUALS",
                    "value": {
                      "amount": {
                        "quantity": "string",
                        "currency": "AED"
                      }
                    }
                  }
                }
              ],
              "pricings": [
                {
                  "ids": [
                    "string"
                  ],
                  "start_at": "2024-01-15T09:30:00Z",
                  "end_at": "2024-01-15T09:30:00Z",
                  "amount": {
                    "quantity": "string",
                    "currency": "AED"
                  },
                  "percentage": "string",
                  "condition": {
                    "comparator": "EQUALS",
                    "value": {
                      "amount": {
                        "quantity": "string",
                        "currency": "AED"
                      }
                    }
                  }
                }
              ],
              "totals": [
                {
                  "start_at": "string",
                  "end_at": "string",
                  "amount": {
                    "quantity": "string",
                    "currency": "AED"
                  },
                  "percentage": "string",
                  "coupon_id": "string",
                  "promotion_code_details": {
                    "promotion_code_id": "string",
                    "code": "string"
                  },
                  "condition": {
                    "comparator": "EQUALS",
                    "value": {
                      "amount": {
                        "quantity": "string",
                        "currency": "AED"
                      }
                    }
                  }
                }
              ],
              "product_categories": [
                {
                  "ids": [
                    "string"
                  ],
                  "start_at": "string",
                  "end_at": "string",
                  "amount": {
                    "quantity": "string",
                    "currency": "AED"
                  },
                  "percentage": "string",
                  "coupon_id": "string",
                  "promotion_code_details": {
                    "promotion_code_id": "string",
                    "code": "string"
                  },
                  "condition": {
                    "comparator": "EQUALS",
                    "value": {
                      "amount": {
                        "quantity": "string",
                        "currency": "AED"
                      }
                    }
                  }
                }
              ],
              "products": [
                {
                  "ids": [
                    "string"
                  ],
                  "start_at": "string",
                  "end_at": "string",
                  "amount": {
                    "quantity": "string",
                    "currency": "AED"
                  },
                  "percentage": "string",
                  "coupon_id": "string",
                  "promotion_code_details": {
                    "promotion_code_id": "string",
                    "code": "string"
                  },
                  "condition": {
                    "comparator": "EQUALS",
                    "value": {
                      "amount": {
                        "quantity": "string",
                        "currency": "AED"
                      }
                    }
                  }
                }
              ],
              "product_items": [
                {
                  "ids": [
                    "string"
                  ],
                  "start_at": "string",
                  "end_at": "string",
                  "amount": {
                    "quantity": "string",
                    "currency": "AED"
                  },
                  "percentage"